ドラフト ECMA-262 / 2025年7月24日

ECMAScript® 2026 言語仕様

この仕様について

https://tc39.es/ecma262/ のドキュメントは、最も正確で 最新の ECMAScript 仕様です。これは最新の年次スナップショットの内容に加え、スナップショット取得以降の 完了した提案提案プロセスで Stage 4 に達し、複数の実装で利用可能となり、次回の実際の改訂に含まれるもの)も含まれています。

このドキュメントは 単一ページ および 複数ページ で利用可能です。

この仕様への貢献について

この仕様は、ECMAScript コミュニティの協力のもと GitHub で開発されています。仕様の開発に貢献する方法はいくつかあります:

このドキュメントの作成方法については コロフォン を参照してください。

はじめに

このEcma規格は、ECMAScript 2026言語を定義します。これはECMAScript言語仕様の第17版です。1997年の初版発行以来、ECMAScriptは世界で最も広く使われている汎用プログラミング言語のひとつに成長しました。主にウェブブラウザに組み込まれている言語として知られていますが、サーバーや組み込みアプリケーションにも広く採用されています。

ECMAScriptは、主にJavaScript(Netscape)やJScript(Microsoft)など、いくつかの元技術に基づいています。この言語はBrendan EichによってNetscapeで発明され、同社のNavigator 2.0ブラウザで初めて登場しました。その後、Netscapeのすべてのブラウザと、MicrosoftのInternet Explorer 3.0以降のすべてのブラウザに実装されています。

ECMAScript言語仕様の開発は1996年11月に始まりました。このEcma規格の初版は、1997年6月のEcma総会で採択されました。

そのEcma規格はISO/IEC JTC 1に迅速な審査手続きで提出され、1998年4月に国際規格ISO/IEC 16262として承認されました。1998年6月のEcma総会では、ISO/IEC 16262と完全に一致させるため、ECMA-262第2版が承認されました。第1版と第2版の変更点は編集上のものです。

第3版では、強力な正規表現、より優れた文字列操作、新しい制御文、try/catch例外処理、エラー定義の厳格化、数値出力の書式指定、将来的な言語拡張を見据えた小規模な変更などが導入されました。ECMAScript標準の第3版は、1999年12月のEcma総会で採択され、2002年6月にISO/IEC 16262:2002として発行されました。

第3版発行後、ECMAScriptはWorld Wide Webとともに爆発的な普及を遂げ、ほぼすべてのウェブブラウザが対応するプログラミング言語となりました。第4版の開発も進みましたが、完成には至らず正式な第4版として発行されませんでした。ただし、その一部は第6版の開発に取り込まれています。

ECMAScript第5版(ECMA-262第5版として発行)は、ブラウザ実装で一般的となった言語仕様の事実上の解釈を明文化し、第3版発行以降に登場した新機能も追加しました。これらには、アクセサプロパティ、オブジェクトの反射的生成・検査、プロパティ属性のプログラム制御、配列操作関数の追加、JSONオブジェクトのエンコード形式対応、エラー検出とプログラムセキュリティを強化するstrict modeなどが含まれます。第5版は2009年12月のEcma総会で採択されました。

第5版はISO/IEC JTC 1に迅速な審査手続きで提出され、国際規格ISO/IEC 16262:2011として承認されました。ECMAScript標準の第5.1版は細かな修正を取り入れており、ISO/IEC 16262:2011と同じ内容です。第5.1版は2011年6月のEcma総会で採択されました。

第6版の本格的な開発は2009年に始まりましたが、これは第3版(1999年発行)以降に行われてきたさまざまな実験や言語拡張設計の集大成です。この版の目標には、大規模アプリケーションやライブラリの開発、他言語のコンパイル先としてのECMAScript利用の強化が含まれていました。主な拡張としては、モジュール、クラス宣言、レキシカルブロックスコープ、イテレータとジェネレータ、非同期プログラミング用のプロミス、分割代入、適切な末尾呼び出しなどがあります。ECMAScript組み込みライブラリも拡張され、マップやセット、バイナリ数値値の配列、文字列・正規表現のUnicode補助文字対応などが追加されました。組み込みはサブクラス化で拡張可能となり、第6版は定期的かつ漸進的な言語・ライブラリエンハンスの基盤を提供します。第6版は2015年6月の総会で採択されました。

ECMAScript 2016は、Ecma TC39の新しい年次リリース体制と公開開発プロセスの下でリリースされた最初の版です。ECMAScript 2015のソースをプレーンテキストに変換した文書が、GitHub上での開発ベースとして使われました。この標準の開発期間中、数百件のプルリクエストやイシューが提出され、何千ものバグ修正、編集修正、その他の改善が行われました。また、Ecmarkup、Ecmarkdown、Grammarkdownなどのソフトウェアツールも開発されました。ES2016では新しいべき乗演算子やArray.prototypeincludesメソッドが追加されました。

ECMAScript 2017では、Async Functions、Shared Memory、Atomicsの導入、その他小規模な言語・ライブラリの拡張、バグ修正、編集更新が行われました。Async FunctionsはPromiseを返す関数のための構文を提供し、非同期プログラミング体験を向上させました。Shared MemoryとAtomicsは、並列CPU上でも確定した実行順序を維持できる原子的操作を使って複数エージェント間で通信できる新しいメモリモデルを導入しました。さらに、Objectの新しい静的メソッドObject.valuesObject.entriesObject.getOwnPropertyDescriptorsも追加されました。

ECMAScript 2018では、非同期イテレータプロトコルおよび非同期ジェネレータによる非同期反復処理が導入されました。また、正規表現に4つの新機能(dotAllフラグ、名前付きキャプチャグループ、Unicodeプロパティエスケープ、後方参照)が追加され、オブジェクトのrest/spreadプロパティも追加されました。

ECMAScript 2019では、配列の平坦化のためのflatおよびflatMapArray.prototype)、Object.entriesの戻り値を直接新しいオブジェクトに変換するObject.fromEntries、より適切な名称のtrimStarttrimEndString.prototype、従来のtrimLeft/trimRightの代替)、その他細かな構文・意味論の更新が導入されました。構文の更新にはcatchバインディングパラメータの省略や、JSONとの整合性のために文字列リテラルでU+2028(LINE SEPARATOR)とU+2029(PARAGRAPH SEPARATOR)を許可することなどがあります。そのほか、Array.prototype.sortの安定化、JSON.stringifyのUTF-8出力標準化、Function.prototype.toStringの仕様明確化などが行われました。

ECMAScript 2020(第11版)では、グローバル正規表現による全マッチオブジェクトのイテレータを生成するmatchAllメソッド(Strings)、動的な指定子でモジュールを非同期インポートするimport()構文、任意精度整数用の新しい数値プリミティブBigInt、短絡しない新しいPromise合成手法Promise.allSettled、グローバルthis値への統一的アクセスglobalThis、モジュール内で使うexport * as ns from 'module'構文、for-in列挙順の標準化、モジュールに関するコンテキスト情報を持つimport.metaホストが設定)、nullish値(undefinednull)操作を改善するnullish coalescing演算子・optional chaining演算子などが導入されました。

ECMAScript 2021(第12版)では、Strings用のreplaceAllメソッド、Promise合成のPromise.any(入力値のいずれかがfulfilledになると短絡)、複数のエラーを同時に表現する新しいError型AggregateError、論理代入演算子(??=&&=||=)、ガベージコレクションから保護せずにターゲットオブジェクトを参照するWeakRef、ターゲットオブジェクトのガベージコレクション時にクリーンアップ操作を管理するFinalizationRegistry、数値リテラルの区切り文字(1_000)、Array.prototype.sortの仕様厳密化(実装定義 ソート順のケース減少)などがあります。

ECMAScript 2022(第13版)では、モジュールのトップレベルでawaitを使えるようになり(キーワード)、新しいクラス要素(public/privateインスタンスフィールド、public/private静的フィールド、privateインスタンスメソッド・アクセサ、private静的メソッド・アクセサ)、クラス内staticブロック(クラス単位の評価初期化)、#x in obj構文(オブジェクトのprivateフィールドの存在判定)、正規表現のマッチインデックス(/dフラグ)、Errorオブジェクトのcauseプロパティ(エラーの因果関係記録)、Strings/Arrays/TypedArrays用のatメソッド(相対インデックス)、Object.hasOwnObject.prototype.hasOwnPropertyの便利な代替)などが導入されました。

ECMAScript 2023(第14版)では、Array.prototypeTypedArray.prototypetoSortedtoReversedwithfindLastfindLastIndexが追加され、Array.prototypeにはtoSplicedが追加されました。また、実行可能なECMAScriptファイルのためにファイル先頭の#!コメント対応、ほとんどのSymbolをweakコレクションのキーとして利用可能になりました。

ECMAScript 2024(第15版)では、ArrayBufferやSharedArrayBufferのリサイズ・転送機能、文字列集合処理に便利な新しいRegExpの/vフラグ、Promise構築を容易にするPromise.withResolvers、データ集計用のObject.groupByおよびMap.groupBy、共有メモリの非同期変更待機用Atomics.waitAsync、Unicodeの正当性チェックと修正用String.prototype.isWellFormedString.prototype.toWellFormedなどが追加されました。

ECMAScript 2025(第16版)では、イテレータ操作のための新しいグローバルIteratorイテレータ用の静的・プロトタイプメソッド)、Set.prototype用のセット操作メソッド、JSONモジュールのインポートとインポート属性宣言構文、正規表現で安全に使えるよう文字列エスケープするRegExp.escapeメソッド、正規表現修飾フラグのインライン制御構文、関数のPromise化のためのPromise.tryメソッド、そして新しいFloat16ArrayTypedArrayの一種)、関連するDataView.prototype.getFloat16DataView.prototype.setFloat16Math.f16roundメソッドが追加されました。

Ecma TC39には多くの団体を代表する何十人もの個人が本版および過去の版の発展に大きく貢献しています。さらに、TC39のECMAScript活動を支える活発なコミュニティが生まれ、数多くのドラフトのレビュー、何千件ものバグ報告、実装実験、テストスイートの提供、世界中の開発者への教育が行われています。残念ながら、貢献者全員を特定し、記載することは不可能です。

Allen Wirfs-Brock
ECMA-262, プロジェクトエディター, 第6版

Brian Terlson
ECMA-262, プロジェクトエディター, 第7〜10版

Jordan Harband
ECMA-262, プロジェクトエディター, 第10〜12版

Shu-yu Guo
ECMA-262, プロジェクトエディター, 第12〜16版

Michael Ficarra
ECMA-262, プロジェクトエディター, 第12〜16版

Kevin Gibbons
ECMA-262, プロジェクトエディター, 第12〜16版

1 範囲

本規格はECMAScript 2026汎用プログラミング言語を定義します。

2 適合性

ECMAScriptの適合実装は、本仕様で記述されているすべての型、値、オブジェクト、プロパティ、関数、プログラム構文および意味論を提供し、サポートしなければなりません。

ECMAScriptの適合実装は、入力されたソーステキストをUnicode標準およびISO/IEC 10646の最新バージョンに準拠して解釈しなければなりません。

異なる言語や国の言語的・文化的慣習に適応するプログラムをサポートするアプリケーションプログラミングインターフェース(API)を提供するECMAScriptの適合実装は、本仕様と互換性のある最新のECMA-402版で定義されるインターフェースを実装しなければなりません。

ECMAScriptの適合実装は、本仕様で記述されている内容以外にも、追加の型、値、オブジェクト、プロパティ、関数を提供してもかまいません。特に、適合実装は本仕様で記載されていないプロパティや、そのプロパティの値を、本仕様で記述されているオブジェクトに対して提供してもかまいません。

ECMAScriptの適合実装は、本仕様で記載されていないプログラム構文や正規表現構文をサポートしてもかまいません。特に、適合実装は本仕様の予約語に記載されている「将来の予約語」を用いたプログラム構文をサポートすることができます(12.7.2参照)。

ECMAScriptの適合実装は、本仕様の17.1で禁じられている拡張(Forbidden Extension)を実装してはなりません。

ECMAScriptの適合実装は、実装定義実装近似、またはホスト定義でない機能を再定義してはなりません。

ECMAScriptの適合実装は、規範的オプション(Normative Optional)サブ句を実装するかどうかを選択できます。規範的オプションの動作を実装する場合は、包含している規範的オプション句内のすべての動作を実装しなければなりません。規範的オプション句は、本仕様で「Normative Optional」と表示された色付きのボックスで示されます(下記参照)。

2.1 規範的オプション句の見出し例

句の内容例。

ECMAScriptの適合実装は、規範的オプションとしてもマークされていない限り、レガシー(Legacy)サブ句を実装しなければなりません。レガシーサブ句内で規定されている言語機能や動作には、ひとつ以上の望ましくない特徴がありますが、既存アプリケーションでの利用が継続されているため、本仕様から削除できません。これらの機能はECMAScript言語の中核部分とはみなされません。プログラマーは新しいECMAScriptコードを書く際、これらの機能や動作の利用や存在を前提にすべきではありません。

2.2 レガシー句の見出し例

句の内容例。

2.3 レガシー規範的オプション句の見出し例

句の内容例。

3 規範参照文献

以下の参照文書は、本書の適用に不可欠です。日付付き参照については、引用された版のみが適用されます。日付なし参照については、参照文書の最新版(改訂および修正を含む)が適用されます。

IEEE 754-2019IEEE 浮動小数点算術標準

Unicode標準。
https://unicode.org/versions/latest

ISO/IEC 10646, 情報技術 ― ユニバーサル多オクテット符号化文字集合 (UCS) と改訂1:2005、改訂2:2006、改訂3:2008、改訂4:2008、追加改訂・正誤表、または後継。

ECMA-402, ECMAScript国際化API仕様、本仕様の版に対応する年次版。
https://www.ecma-international.org/publications-and-standards/standards/ecma-402/

ECMA-404, JSONデータ交換フォーマット
https://www.ecma-international.org/publications-and-standards/standards/ecma-404/

4 概要

この節はECMAScript言語の非規範的な概要を含みます。

ECMAScriptは、ホスト環境内で計算を行い、計算オブジェクトを操作するためのオブジェクト指向プログラミング言語です。ここで定義されるECMAScriptは、計算上自己完結することを意図していません。実際、本仕様には外部データの入力や計算結果の出力に関する規定がありません。代わりに、ECMAScriptプログラムの計算環境が、本仕様で記述されているオブジェクトやその他の機能だけでなく、環境固有のオブジェクトも提供することが想定されています。これらのオブジェクトの説明や動作は本仕様の範囲外ですが、特定のプロパティへのアクセスや関数呼び出しがECMAScriptプログラムから可能であることが示されています。

ECMAScriptは当初スクリプト言語として設計されましたが、現在では汎用プログラミング言語として広く使われています。スクリプト言語とは、既存システムの機能を操作・カスタマイズ・自動化するためのプログラミング言語です。こうしたシステムでは、ユーザーインターフェースを通じて有用な機能がすでに利用可能であり、スクリプト言語はその機能をプログラム制御に公開する手段となります。このように、既存システムはスクリプト言語の機能を補完するホスト環境のオブジェクトや機能を提供します。スクリプト言語は、専門・非専門いずれのプログラマーにも利用されることを想定しています。

ECMAScriptは当初Webスクリプト言語として設計され、ブラウザでWebページを動的にし、Webベースのクライアントサーバーアーキテクチャの一部としてサーバ計算を行う仕組みを提供していました。現在、ECMAScriptは様々なホスト環境のコアスクリプト機能として利用されています。そのため、コア言語は特定のホスト環境とは切り離して本書で規定されています。

ECMAScriptの利用は単純なスクリプトを超え、さまざまな環境や規模で多岐にわたるプログラミング業務に使われています。利用拡大に伴い、ECMAScriptが提供する機能や設備も拡充されました。現在、ECMAScriptは完全な機能を備えた汎用プログラミング言語となっています。

4.1 Webスクリプティング

ウェブブラウザは、クライアントサイド計算のためのECMAScriptホスト環境を提供します。これにはウィンドウ、メニュー、ポップアップ、ダイアログボックス、テキストエリア、アンカー、フレーム、履歴、クッキー、入出力などを表すオブジェクトが含まれます。また、ホスト環境は、フォーカス変更、ページや画像の読み込み・アンロード・エラー・中断・選択・フォーム送信・マウス操作などのイベントにスクリプトコードを関連付ける手段も提供します。スクリプトコードはHTML内に記述され、表示されるページはユーザーインターフェース要素と固定・計算済みのテキストや画像の組み合わせです。スクリプトコードはユーザー操作に反応し、メインプログラムは不要です。

ウェブサーバは、サーバサイド計算のための別のホスト環境を提供します。これにはリクエスト・クライアント・ファイルを表すオブジェクトや、データのロック・共有機構が含まれます。ブラウザ側とサーバ側のスクリプトを組み合わせることで、クライアントとサーバ間で計算を分散し、Webベースアプリケーションのユーザーインターフェースをカスタマイズできます。

ECMAScriptをサポートする各Webブラウザとサーバは、それぞれ独自のホスト環境を提供し、ECMAScript実行環境を完成させます。

4.2 ホストと実装

ECMAScriptをホスト環境に統合しやすくするために、本仕様では特定の機能(例:抽象操作)の定義を、全体または一部を外部ソースに委ねています。編集上、本仕様は以下の種類の委譲を区別しています。

実装は、付録Dで列挙された機能や、実装定義または実装近似とマークされた機能をさらに定義する外部ソースです。非公式には、実装は特定のWebブラウザなどの具体的な成果物を指します。

実装定義機能は、定義を外部ソースに委ねるものです。本仕様は特定の動作について推奨を行わず、適合実装は本仕様で定められた制約内で任意の動作を選択できます。

実装近似機能は、定義を外部ソースに委ねつつ、理想的な動作を推奨するものです。適合実装は制約内で任意の動作を選択できますが、理想的な動作に近づけることが奨励されます。例えば、Math.expなどの数学操作は実装近似です。

ホストは、付録Dに記載された機能のみをさらに定義する外部ソースであり、その他の実装定義実装近似機能は定義しません。非公式には、ホストは、付録Dを通じて本仕様と同じ方法でインターフェースするすべてのWebブラウザの集合などを指します。ホストはWHATWG HTML(https://html.spec.whatwg.org/)などの外部仕様であることが多いです。つまり、ホスト定義機能は外部仕様でさらに定義される場合が多いです。

ホストフックは、全体または一部が外部ソースで定義される抽象操作です。すべてのホストフックは付録Dに列挙されなければなりません。ホストフックは、以下の要件を満たす必要があります:

ホスト定義機能は、定義を外部ソースに委ねるもので、付録Dに列挙されるものです。ホストでない実装も、ホスト定義機能の定義を提供できます。

ホスト環境は、すべてのホスト定義機能の定義選択です。ホスト環境は、ホスト定義プロパティとして、グローバルオブジェクトから入力取得や出力提供を可能にするオブジェクトや関数などを含むことが一般的です。

本仕様は、常に最も具体的な用語を使う編集慣例に従います。例えば、機能がホスト定義であれば、実装定義として参照すべきではありません。

ホストと実装の両方が、本仕様で定義される言語型、仕様型、抽象操作、文法生成規則、組み込みオブジェクト、組み込みシンボルを通じて本仕様とインターフェースできます。

4.3 ECMAScript概要

以下はECMAScriptの非公式な概要です。言語のすべての部分が説明されているわけではありません。この概要は規格本体の一部ではありません。

ECMAScriptはオブジェクトベースです。基本的な言語機能やホスト機能はオブジェクトによって提供され、ECMAScriptプログラムは通信するオブジェクトの集合体です。ECMAScriptにおいて、オブジェクトは0個以上のプロパティの集合であり、各プロパティにはその利用方法を決定する属性があります。例えば、プロパティのWritable属性がfalseに設定されている場合、実行されたECMAScriptコードがそのプロパティに異なる値を代入しようとしても失敗します。プロパティは他のオブジェクト、プリミティブ値、または関数を保持するコンテナです。プリミティブ値は以下の組み込み型のいずれかのメンバーです:UndefinedNullBooleanNumberBigIntStringSymbol。オブジェクトは組み込み型Objectのメンバーです。関数は呼び出し可能なオブジェクトです。オブジェクトのプロパティを通じて関連付けられた関数はメソッドと呼ばれます。

ECMAScriptは、ECMAScriptエンティティの定義を補完する組み込みオブジェクトの集合も定義します。これらの組み込みオブジェクトには、グローバルオブジェクト、言語の実行時意味論に不可欠なObjectFunctionBooleanSymbol、各種Errorオブジェクト、数値値の表現・操作用MathNumberDate、テキスト処理用のStringRegExp、値のインデックス付きコレクションであるArrayと9種類のTyped Array(要素が特定の数値データ表現を持つ)、キー付きコレクションのMapSetオブジェクト、構造化データ用のJSONオブジェクト、ArrayBufferSharedArrayBufferDataView、制御抽象のためのジェネレータ関数やPromiseオブジェクト、リフレクション用のProxyReflectなどが含まれます。

ECMAScriptは組み込み演算子も定義しています。ECMAScriptの演算子には、様々な単項演算、乗算演算子、加算演算子、ビットシフト演算子、関係演算子、等価演算子、2項ビット演算子、2項論理演算子、代入演算子、カンマ演算子などがあります。

大規模なECMAScriptプログラムはモジュールによってサポートされており、プログラムを複数の文や宣言の列に分割できます。各モジュールは、他のモジュールから提供される必要がある宣言、および他のモジュールで利用可能な自身の宣言を明示的に識別します。

ECMAScriptの構文は意図的にJavaの構文に似せてあります。ECMAScriptの構文は、使いやすいスクリプト言語として機能するよう緩和されています。例えば、変数は型宣言が不要であり、プロパティにも型は関連付けられず、定義された関数は呼び出しより前に宣言が現れている必要はありません。

4.3.1 オブジェクト

ECMAScriptはクラス定義の構文を含みますが、ECMAScriptオブジェクトはC++、Smalltalk、Javaのように本質的にクラスベースではありません。代わりに、オブジェクトはリテラル記法やコンストラクタによって様々な方法で生成できます。コンストラクタはオブジェクトを生成し、初期値をプロパティに代入して初期化するコードを実行します。各コンストラクタ"prototype"という名前のプロパティを持ち、プロトタイプベースの継承共有プロパティを実現します。オブジェクトはnew式でコンストラクタを使用して作成されます。例えば、new Date(2009, 11)は新しいDateオブジェクトを生成します。newを使わずにコンストラクタを呼び出すと、その結果はコンストラクタ次第で異なります。例えば、Date()はオブジェクトではなく現在の日時の文字列を生成します。

コンストラクタで生成されたすべてのオブジェクトは、暗黙の参照(オブジェクトのプロトタイプ)を自身のコンストラクタ"prototype"プロパティ値に持ちます。さらに、プロトタイプは非nullのプロトタイプへの暗黙の参照を持つことがあり、これがプロトタイプチェーンです。オブジェクトのプロパティに参照が行われると、その参照はプロトタイプチェーン上でその名前のプロパティを持つ最初のオブジェクトのプロパティに向けられます。つまり、まず直接指定されたオブジェクトを調べ、そのオブジェクトに名前付きプロパティがあればそれが参照先です。なければそのオブジェクトのプロトタイプを次に調べ、以降も同様です。

図1: オブジェクト/プロトタイプ関係
箱と矢印が多数描かれている図。

クラスベースのオブジェクト指向言語では、一般に、状態はインスタンスが保持し、メソッドはクラスが保持し、継承は構造と振る舞いのみです。ECMAScriptでは、状態もメソッドもオブジェクトが保持し、構造・振る舞い・状態のすべてが継承されます。

プロトタイプが特定のプロパティを持っていて、そのプロパティを直接持たないすべてのオブジェクトは、そのプロパティと値を共有します。図1はこの関係を示しています。

CFコンストラクタ(かつオブジェクト)です。5つのオブジェクト(cf1cf2cf3cf4cf5)がnew式で生成されています。各オブジェクトは"q1""q2"というプロパティを持ちます。破線は暗黙のプロトタイプ関係を表し、例えばcf3のプロトタイプはCFpです。コンストラクタCF自体は、"P1""P2"という2つのプロパティを持ちますが、これらはCFpcf1cf2cf3cf4cf5からは見えません。CFp"CFP1"プロパティは、cf1cf2cf3cf4cf5CFは除く)で共有されます。また、CFpの暗黙のプロトタイプチェーン上で"q1""q2""CFP1"以外のプロパティも共有されます。CFCFpの間には暗黙のプロトタイプリンクはありません。

ほとんどのクラスベースオブジェクト言語と異なり、オブジェクトには値を代入することで動的にプロパティを追加できます。つまり、コンストラクタは、生成されるオブジェクトのすべてまたは一部のプロパティに名前や値の代入を必須としません。上図の場合、CFpに新たな値を代入することで、cf1cf2cf3cf4cf5に新しい共有プロパティを追加できます。

ECMAScriptオブジェクトは本質的にクラスベースではありませんが、共通パターンのコンストラクタ関数、プロトタイプオブジェクト、メソッドに基づいてクラス的な抽象を定義するのが便利です。ECMAScriptの組み込みオブジェクト自身もこのようなクラス的パターンに従っています。ECMAScript 2015以降、ECMAScript言語には組み込みオブジェクトと同様のクラス的抽象パターンに準拠したオブジェクトを簡潔に定義可能なクラス定義構文が追加されています。

4.3.2 ECMAScriptの厳格なバリアント

ECMAScript言語は、言語の一部機能の利用を制限したいユーザーがいる可能性を認識しています。これは、セキュリティの観点、エラーを招きやすい機能の回避、エラー検出の強化、その他ユーザー独自の理由によるものです。この可能性をサポートするために、ECMAScriptは言語の厳格なバリアントを定義しています。厳格なバリアントでは、通常のECMAScript言語から特定の構文的・意味的機能を除外し、一部機能の詳細な意味論を変更します。厳格なバリアントでは、非厳格な言語形式ではエラーとされない状況でも、エラー例外をthrowして報告しなければならない追加のエラー条件も規定しています。

ECMAScriptの厳格なバリアントは、一般に言語のstrict mode(厳格モード)と呼ばれます。厳格モードの選択と構文・意味論の利用は、ECMAScriptソーステキスト単位で明示的に行われます(11.2.2参照)。厳格モードは構文ソーステキスト単位で選択されるため、その制限はそのユニット内で局所的にのみ適用されます。厳格モードは、複数のソーステキストユニット間で一貫して動作するECMAScriptの意味論の側面を制限・変更しません。完全なECMAScriptプログラムは、厳格モードと非厳格モードの両方のECMAScriptソーステキストユニットで構成される場合があります。この場合、厳格モードは実際に厳格モードソーステキストユニット内で定義されたコードが実行される場合にのみ適用されます。

本仕様に適合するために、ECMAScriptの実装は本仕様で定義された完全な非制限ECMAScript言語と厳格なバリアントの両方を実装しなければなりません。さらに、非制限モードと厳格モードのソーステキストユニットの組み合わせによる複合プログラムもサポートしなければなりません。

4.4 用語と定義

本書の目的において、以下の用語と定義が適用されます。

4.4.1 implementation-approximated

implementation-approximated 機能は、全体または一部が外部ソースによって定義されますが、本仕様に推奨される理想的な動作があります。

4.4.2 implementation-defined

implementation-defined 機能は、本仕様に対する外部ソースによって全体または一部が定義されます。

4.4.3 host-defined

implementation-defined と同じ

編集上の観点では、4.2 節を参照してください。

4.4.4 type

6 節で定義されるデータ値の集合

4.4.5 primitive value

型 Undefined、Null、Boolean、Number、BigInt、Symbol、String のいずれかのメンバー(6 節参照)

プリミティブ値は、言語実装の最下層レベルで直接表現されるデータです。

4.4.6 object

型 Object のメンバー

オブジェクトはプロパティの集合体であり、単一のプロトタイプオブジェクトを持ちます。プロトタイプは null であってもよいです。

4.4.7 constructor

オブジェクトを生成・初期化する function object

constructor"prototype" プロパティの値は、継承と共有プロパティの実装に使用されるプロトタイプオブジェクトです。

4.4.8 prototype

他のオブジェクトに共有プロパティを提供するオブジェクト

constructor がオブジェクトを生成すると、そのオブジェクトはプロパティ参照解決のために暗黙的に constructor"prototype" プロパティを参照します。constructor"prototype" プロパティは、プログラム式 constructor.prototype で参照でき、プロトタイプに追加されたプロパティは継承によりそのプロトタイプを共有するすべてのオブジェクトで共有されます。あるいは、Object.create 組み込み関数を使って明示的に指定したプロトタイプ付きの新しいオブジェクトを生成することもできます。

4.4.9 ordinary object

すべてのオブジェクトがサポートすべき本質的な内部メソッドに対してデフォルトの動作を持つオブジェクト

4.4.10 exotic object

本質的な内部メソッドのうち1つ以上についてデフォルトの動作を持たないオブジェクト

ordinary object でないオブジェクトはすべて exotic object です。

4.4.11 standard object

本仕様で意味論が定義されているオブジェクト

4.4.12 built-in object

ECMAScript実装によって規定・提供されるオブジェクト

標準の組み込みオブジェクトは本仕様で定義されています。ECMAScript実装は追加の組み込みオブジェクトを規定・提供してもかまいません。

4.4.13 undefined value

変数に値が代入されていない場合に使われるプリミティブ値

4.4.14 Undefined type

唯一の値が undefined である型

4.4.15 null value

いかなるオブジェクト値も意図的に存在しないことを表すプリミティブ値

4.4.16 Null type

唯一の値が null である型

4.4.17 Boolean value

Boolean type のメンバー

Boolean値は truefalse の2つのみです。

4.4.18 Boolean type

プリミティブ値 true および false からなる型

4.4.19 Boolean object

標準組み込み Boolean constructor のインスタンスである Object type のメンバー

Booleanオブジェクトは、Boolean constructornew 式で使い、Boolean値を引数として生成されます。生成されたオブジェクトは内部スロットにBoolean値を保持します。BooleanオブジェクトはBoolean値に強制変換することができます。

4.4.20 String value

ゼロ以上の16ビット符号なし integer 値の有限な順序付き列であるプリミティブ値

String値は String type のメンバーです。列内の各 integer 値は通常、UTF-16テキストの16ビット単位を表します。ただし、ECMAScriptでは値に関して16ビット符号なし integer であること以外の制約や要件はありません。

4.4.21 String type

すべての可能なString値の集合

4.4.22 String object

標準組み込み String constructor のインスタンスである Object type のメンバー

Stringオブジェクトは、String constructornew 式で使い、String値を引数として生成されます。生成されたオブジェクトは内部スロットにString値を保持します。Stringオブジェクトは、String constructor を関数として呼び出すことでString値に強制変換できます(22.1.1.1)。

4.4.23 Number value

倍精度64ビットバイナリ形式 IEEE 754-2019 値に対応するプリミティブ値

Number値は Number type のメンバーであり、数値を直接表現します。

4.4.24 Number type

すべての可能なNumber値の集合(NaN(非数)、+∞𝔽(正の無限大)、-∞𝔽(負の無限大)を含む)

4.4.25 Number object

標準組み込み Number constructor のインスタンスである Object type のメンバー

Numberオブジェクトは、Number constructornew 式で使い、Number値を引数として生成されます。生成されたオブジェクトは内部スロットにNumber値を保持します。Numberオブジェクトは、Number constructor を関数として呼び出すことでNumber値に強制変換できます(21.1.1.1)。

4.4.26 Infinity

正の無限大のNumber値

4.4.27 NaN

IEEE 754-2019 のNaN(非数)値であるNumber値

4.4.28 BigInt value

任意精度 integer 値に対応するプリミティブ値

4.4.29 BigInt type

すべての可能なBigInt値の集合

4.4.30 BigInt object

標準組み込み BigInt constructor のインスタンスである Object type のメンバー

4.4.31 Symbol value

ユニークな、非Stringオブジェクト property key を表すプリミティブ値

4.4.32 Symbol type

すべての可能なSymbol値の集合

4.4.33 Symbol object

標準組み込み Symbol constructor のインスタンスである Object type のメンバー

4.4.34 function

サブルーチンとして呼び出すことができる Object type のメンバー

関数はプロパティに加え、呼び出されたときの挙動を決定する実行コードと状態を持ちます。関数のコードはECMAScriptで記述されている場合とそうでない場合があります。

4.4.35 built-in function

関数である組み込みオブジェクト

組み込み関数の例:parseIntMath.expホストや実装は、本仕様に記載されていない追加の組み込み関数を提供することがあります。

4.4.36 built-in constructor

constructor である組み込み関数

組み込み constructor の例:ObjectFunctionホストや実装は、本仕様に記載されていない追加の組み込み constructor を提供することがあります。

4.4.37 property

キー(String値またはSymbol値)と値を関連付けるオブジェクトの一部

プロパティの形態によって、値はデータ値(プリミティブ値、オブジェクト、function object)として直接表現される場合もあれば、アクセサ関数のペアによって間接的に表現される場合もあります。

4.4.38 method

プロパティの値である関数

関数がオブジェクトのメソッドとして呼び出されると、そのオブジェクトは関数に this 値として渡されます。

4.4.39 built-in method

組み込み関数であるメソッド

標準組み込みメソッドは本仕様で定義されています。ホストや実装は、本仕様に記載されていない追加の組み込みメソッドを提供することがあります。

4.4.40 attribute

プロパティの特徴を定義する内部値

4.4.41 own property

オブジェクトが直接保持するプロパティ

4.4.42 inherited property

オブジェクト自身のプロパティではないが、そのオブジェクトのプロトタイプの(自身または継承された)プロパティであるプロパティ

4.5 本仕様書の構成

本仕様書の残りの部分は以下のように構成されています:

5節では、仕様全体で使用される記法上の規約を定義します。

6節から第10節までは、ECMAScriptプログラムが動作する実行環境を定義します。

11節から第17節までは、ECMAScriptプログラミング言語そのもの(構文的表現や全言語機能の実行意味論)を定義します。

18節から第28節までは、ECMAScript標準ライブラリを定義します。これらの節には、ECMAScriptプログラムが実行時に利用可能なすべての標準オブジェクトの定義が含まれます。

29節では、SharedArrayBufferを利用したメモリへのアクセスの一貫性モデルおよびAtomicsオブジェクトのメソッドについて説明します。

5 記法上の規則

5.1 構文および字句文法

5.1.1 文脈自由文法

文脈自由文法は複数の生成規則から成ります。各生成規則は、非終端記号と呼ばれる抽象記号を左辺とし、0個以上の非終端記号および終端記号記号から成る列を右辺とします。各文法において、終端記号は特定のアルファベットから選ばれます。

連鎖生成規則は、右辺にちょうど1つの非終端記号と0個以上の終端記号を持つ生成規則です。

特別な非終端記号(目標記号)のみから成る文を始点として、与えられた文脈自由文法は言語を規定します。つまり、非終端記号を対応する左辺を持つ生成規則の右辺へ繰り返し置換することで得られる終端記号の可能な(無限かもしれない)列の集合です。

5.1.2 字句文法と正規表現文法

ECMAScriptの字句文法は、12で示されています。この文法の終端記号は、SourceCharacterに定義された規則に従うUnicodeコードポイントです(11.1参照)。この文法は、目標記号であるInputElementDivInputElementTemplateTailInputElementRegExpInputElementRegExpOrTemplateTail、 またはInputElementHashbangOrRegExpから始まる生成規則群を定義し、これらがコードポイントの列を入力要素の列へと変換する方法を記述します。

空白やコメント以外の入力要素が、ECMAScriptの構文文法の終端記号となり、ECMAScriptのトークンと呼ばれます。これらのトークンは、予約語、識別子、リテラル、およびECMAScript言語の区切り記号です。さらに、行終端子はトークンとはみなされませんが、入力要素の列に含まれ、自動セミコロン挿入の処理を導きます。単純な空白や一行コメントは破棄され、構文文法の入力要素列には現れません。MultiLineComment(複数行にまたがるかどうかに関わらず/**/形式のコメント)は、行終端子を含まなければ単純に破棄されますが、行終端子を1つ以上含む場合は、1つの行終端子に置換され、構文文法の入力要素列に含まれます。

ECMAScriptの正規表現文法22.2.1に示されます。この文法もSourceCharacterで定義されるコードポイントを終端記号とします。目標記号であるPatternから始まる規則群を定義し、コードポイントの列を正規表現パターンへ変換する方法を記述します。

字句文法と正規表現文法の生成規則は、区切り記号として二重コロン“::”を用いて区別されます。字句文法と正規表現文法は、いくつかの生成規則を共有します。

5.1.3 数値文字列文法

数値文字列文法7.1.4.1に現れます。終端記号はSourceCharacterであり、目標記号であるStringNumericLiteralから(数値リテラルの字句文法に似ているが異なる)、文字列を数値値へ変換するために使われます。

数値文字列文法の生成規則は、三重コロン“:::”を区切り記号として区別され、ソーステキストの解析には決して使用されません。

5.1.4 構文文法

ECMAScriptの構文文法は、13から16までの節で示されています。この文法の終端記号は、字句文法で定義されたECMAScriptトークンです(5.1.2参照)。この文法は、目標記号であるScriptおよびModuleの2つの代替から始まる生成規則群を定義し、トークンの列がECMAScriptプログラムの構文的に正しい独立した構成要素を形成する方法を記述します。

コードポイントの列をECMAScriptのScriptまたはModuleとして解析する場合、まず字句文法を繰り返し適用して入力要素の列へ変換し、その後構文文法を1回適用して解析します。入力列のトークンが、目標非終端記号(ScriptまたはModule)の単一インスタンスとして解析できず、余分なトークンが残る場合は、構文エラーとなります。

解析が成功すると、構文木(根付き木構造)が構築されます。各ノードは構文ノードです。各構文ノードは文法記号のインスタンスであり、その記号から導出可能なソーステキストの範囲を表します。構文木の根ノード(ソーステキスト全体を表す)は、解析の目標記号のインスタンスです。構文ノードが非終端記号のインスタンスである場合、その非終端記号を左辺に持つ生成規則のインスタンスでもあります。さらに、右辺の各記号に対応するを0個以上持ちます:各子は対応する記号のインスタンスである構文ノードです。

新しい構文ノードはパーサーの各呼び出しごとにインスタンス化され、同一ソーステキストであっても解析間で再利用されることはありません。構文ノードは、同じソーステキスト範囲を表し、同じ文法記号のインスタンスであり、同じパーサー呼び出しから生成された場合のみ同じ構文ノードとみなされます。

注1

同じ文字列を複数回解析すると、異なる構文ノードが得られます。例えば、次のようになります:

let str = "1 + 1;";
eval(str);
eval(str);

evalの呼び出しは、strの値をECMAScriptソーステキストへ変換し、個別に解析して独立した構文ノードの木を生成します。各構文木は、同じ文字列値から導出されたソーステキストであっても異なります。

注2
構文ノードは仕様上の概念であり、実装が同様のデータ構造を用いる必要はありません。

構文文法の生成規則は、区切り記号として単一コロン“:”を用いて区別されます。

13から16までで示される構文文法は、ECMAScriptのScriptまたはModuleとして受理されるトークン列の完全な説明ではありません。特定の箇所(例えば行終端文字の前など)にセミコロンを追加した場合のみ記述されるトークン列など、追加で受理される場合があります。さらに、文法で記述されている一部のトークン列も、特定の“厄介な”位置に行終端文字がある場合は受理されません。

曖昧さを避けるために、構文文法では時折拡張生成規則を用いて、ECMAScriptのScriptまたはModuleとして有効ではないトークン列を許容する場合があります。例えば、この手法はオブジェクトリテラルやオブジェクト分割パターンで用いられます。その場合、より制限された補足文法が提供され、受理されるトークン列を追加で制限します。通常、早期エラー規則で、特定の文脈で「"PNカバーしなければならない」と述べます。ここで、Pは(拡張生成規則のインスタンスである)構文ノードであり、Nは補足文法の非終端記号です。これは次を意味します:

  1. Pが元々マッチしたトークン列を、N目標記号として再度解析します。Nが文法パラメータを持つ場合、Pを元々解析したときと同じ値に設定します。
  2. そのトークン列が、余分なトークンなく単一のNインスタンスとして解析できれば:
    1. そのPに対して一意となるNのインスタンス(構文ノード)を「PカバーするN」と呼びます。
    2. Nおよび派生生成規則の全ての早期エラー規則は、PがカバーするNにも適用されます。
  3. そうでなければ(解析に失敗した場合)、早期構文エラーとなります。

5.1.5 文法記法

5.1.5.1 終端記号

ECMAScriptの文法では、一部の終端記号が固定幅フォントで表示されています。これらはソーステキストに記載されたとおりに正確に現れる必要があります。この方法で指定されたすべての終端記号コードポイントは、他のUnicode範囲に類似したコードポイントではなく、Basic Latinブロックの適切なUnicodeコードポイントとみなされます。終端記号内のコードポイントは、\ UnicodeEscapeSequenceとして表現することはできません。

終端記号が個々のUnicodeコードポイントである文法(すなわち字句文法、正規表現文法、数値文字列文法)では、生成規則に複数の固定幅コードポイントが連続して現れる場合、それは同じコードポイント列を個別の終端記号として記載する場合の省略記法です。

例えば、次の生成規則:

HexIntegerLiteral :: 0x HexDigits

は次の省略記法です:

HexIntegerLiteral :: 0 x HexDigits

対照的に、構文文法では固定幅コードポイントの連続は1つの終端記号となります。

終端記号には他にも2つの形式があります:

  • 字句文法と正規表現文法では、通常の印刷表現がないUnicodeコードポイントは「<ABBREV>」の形式で示されます。ここで「ABBREV」はコードポイントまたはコードポイントの集合の記憶語です。これらの形式はUnicode書式制御文字空白、および行終端子で定義されています。
  • 構文文法では、特定の終端記号(例:IdentifierNameRegularExpressionLiteral)はイタリック体で表示されます。これは字句文法の同名の非終端記号を参照することを示します。

5.1.5.2 非終端記号と生成規則

非終端記号はイタリック体で表示されます。非終端記号(「生成規則」とも呼ばれる)の定義は、定義される非終端記号の名前の後にコロンが1つ以上続いて導入されます(コロンの数は生成規則が属する文法を示します)。続く行に、その非終端記号の右辺の選択肢が1つ以上続きます。例えば、次の構文定義:

WhileStatement : while ( Expression ) Statement

は、非終端記号WhileStatementが、whileトークン、左括弧トークン、Expression、右括弧トークン、Statementの順に現れることを表します。ExpressionStatementも非終端記号です。別の例として、次の構文定義:

ArgumentList : AssignmentExpression ArgumentList , AssignmentExpression

は、ArgumentListが、AssignmentExpression単体、またはArgumentListの後にカンマ、その後AssignmentExpressionが続く、いずれかを表すことを示します。このArgumentListの定義は再帰的であり、つまり自身を用いて定義されています。結果として、ArgumentListには任意の個数の引数(各引数式はAssignmentExpression)をカンマ区切りで含めることができます。このような再帰的定義は一般的です。

5.1.5.3 オプション記号

終端記号または非終端記号の後に付く下付き接尾辞「opt」は、オプション記号を示します。オプション記号を含む選択肢は、オプション要素を省略する右辺と含める右辺の2つを実際に指定します。これはつまり:

VariableDeclaration : BindingIdentifier Initializeropt

は次の省略記法です:

VariableDeclaration : BindingIdentifier BindingIdentifier Initializer

また:

ForStatement : for ( LexicalDeclaration Expressionopt ; Expressionopt ) Statement

は次の省略記法です:

ForStatement : for ( LexicalDeclaration ; Expressionopt ) Statement for ( LexicalDeclaration Expression ; Expressionopt ) Statement

さらに次の省略記法となります:

ForStatement : for ( LexicalDeclaration ; ) Statement for ( LexicalDeclaration ; Expression ) Statement for ( LexicalDeclaration Expression ; ) Statement for ( LexicalDeclaration Expression ; Expression ) Statement

したがって、この例では非終端記号ForStatementは実際には4つの右辺選択肢を持ちます。

5.1.5.4 文法パラメータ

生成規則は「[parameters]」という下付き注釈でパラメータ化できます。これは、生成規則で定義される非終端記号の記号の後ろに接尾辞として現れます。「parameters」は名前1つまたはカンマ区切りの名前リストです。パラメータ化された生成規則は、パラメータ名全組み合わせを定義する一連の生成規則の省略記法です。これはつまり:

StatementList[Return] : ReturnStatement ExpressionStatement

は次の省略記法です:

StatementList : ReturnStatement ExpressionStatement StatementList_Return : ReturnStatement ExpressionStatement

また:

StatementList[Return, In] : ReturnStatement ExpressionStatement

は次の省略記法です:

StatementList : ReturnStatement ExpressionStatement StatementList_Return : ReturnStatement ExpressionStatement StatementList_In : ReturnStatement ExpressionStatement StatementList_Return_In : ReturnStatement ExpressionStatement

複数パラメータの場合、生成規則の組み合わせ数は組み合わせ的に増えますが、すべてが完全な文法で参照されるとは限りません。

生成規則右辺で非終端記号への参照もパラメータ化できます。例えば:

StatementList : ReturnStatement ExpressionStatement[+In]

は次の意味です:

StatementList : ReturnStatement ExpressionStatement_In

また:

StatementList : ReturnStatement ExpressionStatement[~In]

は次の意味です:

StatementList : ReturnStatement ExpressionStatement

非終端記号参照はパラメータリストと「opt」接尾辞の両方を持つことができます。例えば:

VariableDeclaration : BindingIdentifier Initializer[+In]opt

は次の省略記法です:

VariableDeclaration : BindingIdentifier BindingIdentifier Initializer_In

右辺の非終端記号参照に「?」を付けると、そのパラメータ値は現在の生成規則左辺記号の該当パラメータの有無によって決まります。例えば:

VariableDeclaration[In] : BindingIdentifier Initializer[?In]

は次の省略記法です:

VariableDeclaration : BindingIdentifier Initializer VariableDeclaration_In : BindingIdentifier Initializer_In

右辺選択肢が「[+parameter]」で始まる場合、その選択肢は指定したパラメータが該当生成規則非終端記号参照で使用されている場合のみ利用できます。「[~parameter]」で始まる場合は参照にそのパラメータが使われていない場合のみ利用できます。これはつまり:

StatementList[Return] : [+Return] ReturnStatement ExpressionStatement

は次の省略記法です:

StatementList : ExpressionStatement StatementList_Return : ReturnStatement ExpressionStatement

また:

StatementList[Return] : [~Return] ReturnStatement ExpressionStatement

は次の省略記法です:

StatementList : ReturnStatement ExpressionStatement StatementList_Return : ExpressionStatement

5.1.5.5 one of

文法定義でコロンの後に「one of」が続く場合、続く行に現れる各終端記号が選択肢となることを示します。例えば、ECMAScriptの字句文法には次の生成規則があります:

NonZeroDigit :: one of 1 2 3 4 5 6 7 8 9

これは次の省略記法です:

NonZeroDigit :: 1 2 3 4 5 6 7 8 9

5.1.5.6 [empty]

生成規則の右辺に「[empty]」と記載されている場合、その生成規則の右辺には終端記号や非終端記号が含まれていないことを示します。

5.1.5.7 先読み制限

生成規則の右辺に「[lookahead = seq]」が現れる場合、その生成規則は直後の入力トークン列の先頭がseqである場合のみ使用可能であることを示します。同様に「[lookahead ∈ set]」(set有限かつ空でないトークン列集合)は、その生成規則が直後のトークン列の先頭にsetのいずれかが現れる場合のみ使用可能であることを示します。便宜上、集合は非終端記号で記載することもでき、その場合はその非終端記号が展開し得るすべてのトークン列集合を表します。非終端記号が無限に異なるトークン列に展開可能な場合は編集上の誤りとなります。

これらの条件は否定も可能です。「[lookahead ≠ seq]」はseqが直後の入力トークン列の先頭ではない場合のみ使用可能、「[lookahead ∉ set]」はsetのいずれも直後のトークン列先頭でない場合のみ使用可能です。

例として、次の定義の場合:

DecimalDigit :: one of 0 1 2 3 4 5 6 7 8 9 DecimalDigits :: DecimalDigit DecimalDigits DecimalDigit

次の定義:

LookaheadExample :: n [lookahead ∉ { 1, 3, 5, 7, 9 }] DecimalDigits DecimalDigit [lookahead ∉ DecimalDigit]

は、「n」の後に1つ以上の10進数字が続き、その先頭が偶数である場合、または10進数字がさらに続かない場合に一致します。

これらの表現が構文文法で使われる場合、直後のトークン列を一意に特定できない場合があります。これは、後続トークンを特定するには後の位置でどの字句目標記号を使うか決める必要があるためです。そのため、構文文法でこれらを使う場合、先読み制限に現れるトークン列seq(集合の一部でも)が、字句目標記号の選択によって先頭になるかどうかが変わる場合は編集上の誤りとなります。

5.1.5.8 [no LineTerminator here]

構文文法の生成規則右辺に「[no LineTerminator here]」と現れる場合、その生成規則は制限付き生成規則であり、指定位置にLineTerminatorが入力列に現れる場合は使用できません。例えば次の生成規則:

ThrowStatement : throw [no LineTerminator here] Expression ;

は、スクリプト内でthrowトークンとExpressionの間にLineTerminatorが現れる場合はこの生成規則が使えないことを示します。

制限付き生成規則でLineTerminatorの存在が禁止されていない限り、入力要素列の任意の2つの連続トークンの間にはLineTerminatorが何回現れても、スクリプトの構文的受理性には影響しません。

5.1.5.9 but not

生成規則右辺で「but not」を使い、除外する展開を指定することができます。例えば次の生成規則:

Identifier :: IdentifierName but not ReservedWord

は、非終端記号Identifierが、IdentifierNameで置換可能なコードポイント列のうち、同じコードポイント列がReservedWordで置換できないものだけを許容することを意味します。

5.1.5.10 説明的表現

最後に、選択肢をすべて列挙するのが非現実的な場合に限り、いくつかの非終端記号はサンセリフ体の説明的表現で記述されています:

SourceCharacter :: 任意のUnicodeコードポイント

5.2 アルゴリズム規約

この仕様書では、アルゴリズムの手順を指定するために番号付きリストを頻繁に使用します。これらのアルゴリズムは、ECMAScript言語構造の必要な意味論を正確に規定するために使われます。アルゴリズムは特定の実装技法の使用を示唆するものではありません。実際には、与えられた機能を実装するために、より効率的なアルゴリズムが利用可能な場合があります。

アルゴリズムは、順序付き・カンマ区切りの別名(エイリアス)名の列で明示的にパラメータ化される場合があります。これらはアルゴリズムの手順内で、その位置に渡された引数を参照するために使われます。オプションのパラメータは角括弧([ , name ])で囲んで表し、アルゴリズム手順内では必須のパラメータと同じ扱いになります。残余パラメータはパラメータリストの末尾に「...」を付けて(, ...name)表し、必須・オプションパラメータの後に渡されたすべての引数をListにまとめます。追加引数がなければ、そのListは空となります。

アルゴリズムの手順は、さらに順序付きのサブステップに分割できます。サブステップはインデントで示され、さらにインデントされたサブステップに分割できます。段階番号付け規則により、最初のレベルは英小文字、2番目はローマ小文字、3レベル以上は4番目以降で数字ラベルが使われます。例えば:

  1. 最上位の手順
    1. サブステップ。
    2. サブステップ。
      1. サブサブステップ。
        1. サブサブサブステップ
          1. サブサブサブサブステップ
            1. サブサブサブサブサブステップ

手順やサブステップは「if」条件文として記述でき、その場合サブステップは条件が真の時のみ適用されます。同じレベルの「if」条件文の次に「else」で始まる手順やサブステップは、その条件の否定です。

手順では、サブステップの反復適用を指定することもできます。

Assert:」で始まる手順は、そのアルゴリズムの不変条件を主張します。これらの主張は、暗黙的なアルゴリズムの不変条件を明示するためのものであり、追加の意味論的要件を加えるものではなく、実装で検証する必要はありません。単にアルゴリズムの明確化のために用いられます。

アルゴリズムの手順では「Let x be someValue」の形式で値に名前付きエイリアスを宣言できます。これらのエイリアスは参照的であり、xsomeValueは同じデータを参照し、どちらかの変更は双方に反映されます。参照的動作を避けたい場合は、手順内で「Let x be a copy of someValue」のように右辺のコピーを明示的に作成する必要があります。

宣言されたエイリアスは、その後の手順で参照できますが、宣言前の手順で参照してはなりません。エイリアスは「Set x to someOtherValue」の形式で変更できます。

5.2.1 抽象操作

この仕様の複数箇所で使用できるように、いくつかのアルゴリズムは抽象操作と呼ばれ、パラメータ化された関数形式で名前付き定義され、他のアルゴリズムから名前で参照できるようになっています。抽象操作は通常、OperationName(arg1, arg2)のような関数適用形式で参照されます。一部の抽象操作は、クラス的な仕様抽象の多態的にディスパッチされるメソッドとして扱われます。そのようなメソッド的抽象操作は、someValue.OperationName(arg1, arg2)のように参照されます。

5.2.2 構文指向操作

構文指向操作は、名前付き操作であり、その定義はECMAScript文法の生成規則(複数の選択肢がある場合はそれぞれ)に関連付けられたアルゴリズムから成ります。複数の選択肢がある生成規則には通常、各選択肢ごとに別個のアルゴリズムがあります。アルゴリズムが文法生成規則に関連付けられる場合、生成規則の終端記号および非終端記号は、アルゴリズムのパラメータのように参照できます。この際、非終端記号は、ソーステキストを解析した際に一致した実際の選択肢定義を参照します。文法生成規則やそれから派生したParse Nodeによって一致したsource text matched byは、一致に参加した最初の終端記号の開始位置から最後の終端記号の終了位置までのソーステキストの範囲です。

生成規則選択肢に関連付けられたアルゴリズムは、通常「[ ]」などの文法注釈なしで示されます。これらの注釈は構文的認識にのみ影響し、選択肢の意味論には影響しません。

構文指向操作は、構文ノードおよび必要に応じて他のパラメータを受けて、以下のアルゴリズムの134の手順に従って呼び出します:

  1. Let status be SyntaxDirectedOperation of SomeNonTerminal.
  2. Let someParseNode be the parse of some source text.
  3. Perform SyntaxDirectedOperation of someParseNode.
  4. Perform SyntaxDirectedOperation of someParseNode with argument "value".

明示的に指定されない限り、すべての連鎖生成規則には、その左辺非終端記号に適用される可能性のあるすべての操作の暗黙的定義があります。暗黙定義は、同じ操作・同じパラメータ(もしあれば)を唯一の右辺非終端記号に再適用し結果を返します。例えば、あるアルゴリズムが「Return Evaluation of Block」という手順を持ち、次のような生成規則があるとします:

Block : { StatementList }

しかし、Evaluation操作がその生成規則にアルゴリズムを関連付けていない場合は、Evaluation操作には次のような関連付けが暗黙的に含まれます:

実行時意味論: Evaluation

Block : { StatementList }
  1. Return Evaluation of StatementList.

5.2.3 実行時意味論

実行時に呼び出される必要のある意味論を規定するアルゴリズムは実行時意味論と呼ばれます。実行時意味論は抽象操作または構文指向操作で定義されます。

5.2.3.1 Completion ( completionRecord )

抽象操作Completionは、引数completionRecordCompletion Record)を受け取り、Completion Recordを返します。これはCompletion Recordが返されることを強調するために使われます。呼び出し時、次の手順を実行します:

  1. Assert: completionRecordCompletion Recordである。
  2. completionRecordを返す。

5.2.3.2 例外を投げる

「例外を投げる」と記載されたアルゴリズム手順(例):

  1. TypeError例外を投げる。

は次の記述と同じ意味です:

  1. 新しく作成したTypeErrorオブジェクトでThrowCompletionを返す。

5.2.3.3 ReturnIfAbrupt

ReturnIfAbrupt(argument)」と記載された、またはそれと同等の意味を持つアルゴリズム手順:

  1. ReturnIfAbrupt(argument)。

は次の意味です:

  1. Assert: argumentCompletion Recordである。
  2. もしargumentabrupt completionなら、Completion(argument)を返す。
  3. それ以外は、argumentargument.[[Value]]に設定する。

また、「ReturnIfAbrupt(AbstractOperation())」と記載された場合:

  1. Let hygienicTemp be AbstractOperation()。
  2. Assert: hygienicTempCompletion Recordである。
  3. もしhygienicTempabrupt completionなら、Completion(hygienicTemp)を返す。
  4. それ以外は、hygienicTemphygienicTemp.[[Value]]に設定する。

ここでhygienicTempはReturnIfAbruptに関する手順内のみ一時的に有効です。

また、「Let result be AbstractOperation(ReturnIfAbrupt(argument))」と記載された場合:

  1. Assert: argumentCompletion Recordである。
  2. もしargumentabrupt completionなら、Completion(argument)を返す。
  3. それ以外は、argumentargument.[[Value]]に設定する。
  4. Let result be AbstractOperation(argument)。

5.2.3.4 ReturnIfAbruptの省略記法

抽象操作および構文指向操作の呼び出し前に?を付けることで、結果のCompletion Recordに対してReturnIfAbruptを適用することを示します。例えば:

  1. ? OperationName()。

は次の手順と同じ意味です:

  1. ReturnIfAbrupt(OperationName())。

同様に、メソッド呼び出し形式の場合:

  1. someValue.OperationName()。

は次の意味です:

  1. ReturnIfAbrupt(someValue.OperationName())。

また、!を前置することで、抽象操作や構文指向操作の呼び出しが決してabrupt completionを返さないことを示し、結果のCompletion Record[[Value]]フィールドのみを返り値として使用します。例えば:

  1. Let val be ! OperationName()。

は次の手順と同じ意味です:

  1. Let val be OperationName()。
  2. Assert: valnormal completionである。
  3. valval.[[Value]]に設定する。

構文指向操作による実行時意味論では、この省略記法を使い、操作呼び出し前に!または?を付けます:

  1. Perform ! SyntaxDirectedOperation of NonTerminal

5.2.3.5 暗黙的な通常完了

抽象操作のアルゴリズム内で、返り値がCompletion Recordとして宣言されている場合や、すべての組み込み関数内では、返される値は最初にNormalCompletionに渡され、その結果が使用されます。この規則はCompletionアルゴリズム内や、返す値がその手順で明示的にCompletion Recordであることを明示している場合には適用されません。これらのケースは:

それ以外の方法でCompletion Recordを返すと編集上の誤りとなります。例えば、これらの抽象操作内で、

  1. Return true

は次のいずれとも同じ意味です:

  1. Return NormalCompletion(true)。

または

  1. Let completion be NormalCompletion(true)。
  2. Return Completion(completion)。

または

  1. Return Completion Record { [[Type]]: normal, [[Value]]: true, [[Target]]: empty }。

ReturnIfAbruptの展開では、展開手順内でCompletionの結果が直接返される場合は許容され、通常ケースではアンラップ後に暗黙的NormalCompletionが適用されます。

  1. Return ? completion

次の例は編集上の誤りです。なぜならCompletion Recordがその手順で注釈なしに返されているからです。

  1. Let completion be NormalCompletion(true)。
  2. Return completion

5.2.4 静的意味論

文脈自由文法だけでは、入力要素列が評価可能な有効なECMAScriptScriptまたはModuleかどうかを定めるすべての規則を表現できません。場合によっては、ECMAScriptアルゴリズム規約か記述的要件で表現される追加規則が必要です。これらの規則は常に文法の生成規則に関連付けられ、該当生成規則の静的意味論と呼ばれます。

静的意味論規則は名前を持ち、通常アルゴリズムで定義されます。名前付き静的意味論規則は文法生成規則に関連付けられ、複数の選択肢がある生成規則には通常、各選択肢ごと・各適用規則ごとに別個のアルゴリズムが定義されます。

静的意味論規則の特例として早期エラー規則があります。早期エラー規則は、特定文法生成規則に関連付けられた早期エラー条件(17参照)を定義します。ほとんどのEvaluationは、仕様書のアルゴリズム内で早期エラー規則を明示的に呼び出しません。適合実装は、ScriptまたはModuleの最初の評価前に、パースに使われた生成規則のすべての早期エラー規則を検証する必要があります。もし早期エラー規則が違反された場合、そのScriptまたはModuleは無効となり評価できません。

5.2.5 数学演算

この仕様書では、次の種類の数値値を参照します:

  • 数学値: 任意の実数で、既定の数値型です。
  • 拡張数学値: 数学値に加え、+∞と-∞を含みます。
  • Numbers: IEEE 754-2019 binary64(倍精度浮動小数点)値です。
  • BigInts: ECMAScript言語値で、任意の整数と一対一で対応します。

この仕様書では、数値値の種類を下付き接尾辞で区別します。下付き𝔽はNumbersを、下付きはBigIntsを指します。下付き接尾辞のない数値値は数学値を指します。ほとんどの数値値は10進法で記載されますが、0xに続く数字0-9やA-Fの形式で16進法値も使われます。

この仕様書で数値値について言及する場合(例:「yの長さ」や「4つの16進数字で表される整数」など)、数値種別が明示されていなければ、数学値を指します。Number値やBigInt値に言及する場合は明示的に注釈されます(例:「…のNumber値」、「…のBigInt値」など)。

この仕様書で整数という用語が使われる場合、特に断りがなければ、数学値で、整数の集合に属するものを指します。整数型Numberという用語は、有限なNumber値で、その数学値が整数の集合に含まれるものを指します。

+, ×, =, ≥などの数値演算子は、オペランドの型ごとに対応する演算を指します。数学値に適用される場合は通常の数学演算、拡張数学値では拡張実数上の通常の数学演算(不定形は未定義で仕様書の編集上誤り)、NumbersではIEEE 754-2019の該当演算、BigIntsではBigIntの数学値に対する通常の数学演算が適用されます。型混合(例:Numberと数学値)の演算子は未定義で仕様書の編集上誤りです。

数学値とNumbersやBigInts間の変換は常に明示的です。数学値拡張数学値xからNumberへの変換は「the Number value for x」または𝔽(x)で表し、6.1.6.1で定義されます。整数xからBigIntへの変換は「the BigInt value for x」またはℤ(x)で表します。NumberやBigIntxから数学値への変換は「the mathematical value of x」またはℝ(x)です。数学値+0𝔽-0𝔽は数学値0です。非有限値の数学値は未定義です。拡張数学値xは、有限値ならその数学値、+∞𝔽なら+∞、-∞𝔽なら-∞、NaNには未定義です。

数学関数abs(x)xの絶対値(x < 0なら-x、それ以外はx自身)を返します。

数学関数min(x1, x2, … , xN)はx1からxNまでの最小値を返し、max(x1, x2, ..., xN)は最大値を返します。これらの関数の定義域と値域は拡張数学値です。

記法「x modulo y」(y有限かつ非ゼロ)は、yと同符号(またはゼロ)の値kを計算し、abs(k) < abs(y)かつx - k = q × yq整数)となる値です。

clamping x between lower and upper」とは、xがlower未満ならlowerupperより大きければupper、それ以外はx自身を返します(lowerupperは数学値でlowerupper)。

数学関数floor(x)は、x以下で最大(+∞に最も近い)整数を返します。

floor(x) = x - (x modulo 1)です。

数学関数truncate(x)は、小数部を切り捨ててゼロ方向に丸めます。x < 0なら-floor(-x)、それ以外はfloor(x)を返します。

数学関数minmaxabsfloortruncateはNumbersやBigIntsには定義されていません。非数学値引数でこれらを使うと仕様書の編集上誤りです。

区間は、下限aから上限bまでの、同じ数値型の値の集合(無限・空の場合もありえます)です。各境界は包含か非包含かが示されます。区間には次の4種があります:

  • 下限a(含む)から上限b(含む)の区間(包含区間)は、a ≤ x ≤ bを満たすすべてのxのみ含みます。
  • 下限a(含む)から上限b(含まない)の区間は、a ≤ x < bを満たすxのみ含みます。
  • 下限a(含まない)から上限b(含む)の区間は、a < x ≤ bを満たすxのみ含みます。
  • 下限a(含まない)から上限b(含まない)の区間は、a < x < bを満たすxのみ含みます。

例えば、下限1(含む)から上限2(含まない)の区間は、1以上2未満のすべての数学値(1を含み2を含まない)からなります。区間定義では、-0𝔽 < +0𝔽(比較対0の記述回避のためコメントあり)、したがって下限+0𝔽の包含区間は+0𝔽のみ含み-0𝔽は含みません。NaNは区間に含まれません。

5.2.6 値記法

この仕様書では、ECMAScript言語値太字で表示されます。例えばnulltrue"hello"などです。これらはECMAScriptソーステキスト(例:Function.prototype.applylet n = 42;)とは区別されます。

5.2.7 同一性

この仕様書では、仕様値とECMAScript言語値は等価性比較されます。値の比較には2種類があります。同一性のない値は、すべての固有特性(整数の大きさや配列の長さなど)が一致すれば他の同一性のない値と等しいとみなされます。同一性のない値は、特性を完全に記述するだけで現すことができます。対して、同一性を持つ値は一意であり、自分自身としか等価でありません。同一性を持つ値は、同一性のない値の性質に加え、推測不可・変更不可・世界的に一意な特性「同一性」を持ちます。既存の同一性を持つ値への参照は、その特性を記述するだけでは現せず、明示的に値の参照を受け渡す必要があります。いくつかの同一性を持つ値は可変であり、特性(同一性以外)がインプレースで変更され、値を保持するすべての場所で新しい特性が観測されます。同一性のない値は同一性を持つ値と等価になることはありません。

この仕様書の観点では、「is」は2つの値の等価性比較(例:「If bool is true, then ...」)、「contains」はリスト内で値を等価性比較して探索(例:「If list contains a Record r such that r.[[Foo]] is true, then ...」)に使われます。仕様上の同一性はこれらの比較結果を決定し、仕様書内で公理的です。

ECMAScript言語の観点では、言語値はSameValue抽象操作およびそれが間接的に呼び出す抽象操作で等価性比較されます。これらの比較抽象操作のアルゴリズムが、ECMAScript言語値の言語上の同一性を決定します。

仕様値の例として、同一性のない値には、数学値拡張数学値ECMAScriptソーステキストサロゲートペアDirective Prologuesなど、UTF-16コードユニット、Unicodeコードポイント、列挙型抽象操作構文指向操作ホストフックなど含む)、順序対など。同一性を持つ仕様値の例には、RecordProperty DescriptorPrivateElementsなど含む)、構文ノードListSetRelationAbstract ClosureData BlockPrivate Name実行コンテキスト実行コンテキストスタックエージェント識別子WaiterList Recordなど。

仕様上の同一性は、Symbol値(Symbol.forで生成されたものを除く)を除き、すべてのECMAScript言語値について言語上の同一性と一致します。仕様・言語同一性を持たないECMAScript言語値は、undefinednullBooleanStringNumberBigIntです。仕様・言語同一性を持つ値は、Symbol値(Symbol.forで生成されないもの)とObjectです。Symbol.forで生成されたSymbol値は仕様上の同一性は持ちますが言語上の同一性は持ちません。

6 ECMAScriptのデータ型と値

この仕様のアルゴリズムは、型が関連付けられた値を操作します。値の型は、まさにこの節で定義されているものだけです。型はさらにECMAScript言語型と仕様型に分類されます。

6.1 ECMAScript言語型

ECMAScript言語型は、ECMAScriptプログラマがECMAScript言語で直接操作する値に対応します。ECMAScript言語型は、Undefined、Null、Boolean、String、Symbol、Number、BigInt、Objectです。ECMAScript言語値は、ECMAScript言語型で特徴付けられる値です。

6.1.1 Undefined型

Undefined型は、undefinedと呼ばれるただ1つの値だけを持ちます。値が代入されていない変数は、undefinedの値を持ちます。

6.1.2 Null型

Null型は、nullと呼ばれるただ1つの値だけを持ちます。

6.1.3 Boolean型

Boolean型は、truefalseという2つの値を持つ論理的な実体を表します。

6.1.4 String型

String型は、最大長253-1要素までの、0個以上の16ビット符号なし整数値(「要素」)の順序付き列の集合です。String型は主に、実行中のECMAScriptプログラムでテキストデータを表すために利用されます。この場合、String内の各要素はUTF-16コード単位値として扱われます。各要素は列内の位置に存在し、位置は非負の整数でインデックスされます。最初の要素(あれば)はインデックス0、次の要素(あれば)はインデックス1、と続きます。Stringの長さはその中の要素(16ビット値)の数です。空文字列は長さ0で、要素を持ちません。

String内容を解釈しないECMAScript操作は、これ以上意味論を与えません。String値を解釈する操作は、各要素を単一のUTF-16コード単位として扱います。ただし、ECMAScriptはこれらのコード単位の値や関係性を制限しないため、さらにString内容をUTF-16で符号化されたUnicodeコードポイントの列として解釈する操作は、不正な部分列を考慮する必要があります。こうした操作は、数値値が0xD800から0xDBFFの包含区間(Unicode標準ではリーディングサロゲート、または正式にはハイサロゲートコード単位)であるすべてのコード単位、また数値値が0xDC00から0xDFFFの包含区間トレーリングサロゲート、または正式にはローサロゲートコード単位)であるすべてのコード単位に特別な処理を以下の規則で適用します:

関数String.prototype.normalize22.1.3.15)はString値を明示的に正規化できます。String.prototype.localeCompare22.1.3.12)は内部でString値を正規化しますが、他の操作は文字列を暗黙的に正規化しません。操作結果は特に記載がなければ言語・ロケールに依存しません。

この設計の理由は、Stringの実装を可能な限り単純かつ高性能に保つことにありました。ECMAScriptソーステキストが正規化形式Cであれば、文字列リテラルはUnicodeエスケープシーケンスを含まない限り、正規化されていることが保証されます。

この仕様では、「string-concatenation of A, B, ...」という表現(各引数はString値、コード単位、またはコード単位の列)は、それぞれの引数(順番通り)のコード単位列を連結したString値を指します。

substring of S from inclusiveStart to exclusiveEnd」という表現(SはString値またはコード単位の列、inclusiveStartexclusiveEnd整数)は、SのインデックスinclusiveStartからexclusiveEnd直前までの連続コード単位のString値を指します(inclusiveStart = exclusiveEndの場合は空文字列)。「to」省略時は、Sの長さがexclusiveEndとなります。

この仕様の「ASCIIワード文字」は、Unicode Basic Latinブロックのすべての文字と数字、およびU+005F(LOW LINE)だけからなる次のString値を指します:
"ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789_"
歴史的理由により、いくつかのアルゴリズムで重要な意味を持ちます。

6.1.4.1 StringIndexOf ( string, searchValue, fromIndex )

抽象操作StringIndexOfは、引数string(String)、searchValue(String)、fromIndex(非負の整数)を取り、非負の整数またはnot-foundを返します。呼び出し時、次の手順を実行します:

  1. lenstringの長さとする。
  2. searchValueが空文字列かつfromIndexlenなら、fromIndexを返す。
  3. searchLensearchValueの長さとする。
  4. fromIndexilen - searchLenとなるすべての整数 iについて昇順で:
    1. candidatestringiからi + searchLenまでのsubstringとする。
    2. candidatesearchValueと等しければ、iを返す。
  5. not-foundを返す。
注1

searchValueが空文字列かつfromIndexstringの長さなら、このアルゴリズムはfromIndexを返します。空文字列は文字列内のすべての位置(最後のコード単位の後も含む)で見つかったものとみなされます。

注2

fromIndex + searchValueの長さがstringの長さを超える場合、このアルゴリズムは常にnot-foundを返します。

6.1.4.2 StringLastIndexOf ( string, searchValue, fromIndex )

抽象操作StringLastIndexOfは、引数string(String)、searchValue(String)、fromIndex(非負の整数)を取り、非負の整数またはnot-foundを返します。呼び出し時、次の手順を実行します:

  1. lenstringの長さとする。
  2. searchLensearchValueの長さとする。
  3. Assert: fromIndex + searchLenlen
  4. 0 ≤ ifromIndexとなるすべての整数 iについて降順で:
    1. candidatestringiからi + searchLenまでのsubstringとする。
    2. candidatesearchValueと等しければ、iを返す。
  5. not-foundを返す。

searchValueが空文字列の場合、このアルゴリズムはfromIndexを返します。空文字列は文字列内のすべての位置(最後のコード単位の後も含む)で見つかったものとみなされます。

6.1.5 Symbol型

Symbol型は、Objectプロパティのキーとして使用できるすべての非String値の集合です(6.1.7参照)。

Symbol値はそれぞれ一意かつ不変です。

各Symbol値は、undefinedまたはString値である[[Description]]という関連値を不変に保持します。

6.1.5.1 既知のSymbol

既知のSymbolは、この仕様のアルゴリズムで明示的に参照される組み込みのSymbol値です。これらは通常、仕様アルゴリズムの拡張ポイントとなる値を持つプロパティのキーとして使用されます。特に規定がなければ、既知のSymbol値はすべてのrealm9.3参照)で共有されます。

この仕様書では、既知のSymbolは標準のintrinsic記法で参照されます。intrinsicは表1に記載されている値のいずれかです。

以前の仕様書の版では@@name形式の記法が使われていましたが、現行版では%Symbol.name%が使われます。特に次の名前が使われていました:@@asyncIterator、@@hasInstance、@@isConcatSpreadable、@@iterator、@@match、@@matchAll、@@replace、@@search、@@species、@@split、@@toPrimitive、@@toStringTag、および@@unscopables。
表1: 既知のSymbol
仕様名 [[Description]] 値と目的
%Symbol.asyncIterator% "Symbol.asyncIterator" オブジェクトのデフォルトの非同期イテレータを返すメソッド。for-await-of文の意味論で呼び出されます。
%Symbol.hasInstance% "Symbol.hasInstance" constructorオブジェクトが、オブジェクトを自身のインスタンスとして認識するかを判定するメソッド。instanceof演算子の意味論で呼び出されます。
%Symbol.isConcatSpreadable% "Symbol.isConcatSpreadable" この値がtrueなら、Array.prototype.concatでオブジェクトが配列要素としてフラット化されることを示すBoolean値プロパティ。
%Symbol.iterator% "Symbol.iterator" オブジェクトのデフォルトのイテレータを返すメソッド。for-of文の意味論で呼び出されます。
%Symbol.match% "Symbol.match" 正規表現メソッドで、正規表現を文字列に対してマッチさせます。String.prototype.matchメソッドで呼び出されます。
%Symbol.matchAll% "Symbol.matchAll" 正規表現メソッドで、文字列に対してマッチした結果を返すイテレータを返します。String.prototype.matchAllメソッドで呼び出されます。
%Symbol.replace% "Symbol.replace" 正規表現メソッドで、文字列の一致部分を置換します。String.prototype.replaceメソッドで呼び出されます。
%Symbol.search% "Symbol.search" 正規表現メソッドで、文字列内で正規表現に一致するインデックスを返します。String.prototype.searchメソッドで呼び出されます。
%Symbol.species% "Symbol.species" 派生オブジェクトの生成に使われるconstructor関数値プロパティ。
%Symbol.split% "Symbol.split" 正規表現メソッドで、正規表現に一致するインデックスで文字列を分割します。String.prototype.splitメソッドで呼び出されます。
%Symbol.toPrimitive% "Symbol.toPrimitive" オブジェクトを対応するプリミティブ値に変換するメソッド。ToPrimitive抽象操作で呼び出されます。
%Symbol.toStringTag% "Symbol.toStringTag" オブジェクトのデフォルト文字列記述の生成に使われるString値プロパティ。組み込みObject.prototype.toStringメソッドでアクセスされます。
%Symbol.unscopables% "Symbol.unscopables" オブジェクト値プロパティで、自身と継承したプロパティ名が、関連オブジェクトのwith環境バインディングから除外されるプロパティ名となります。

6.1.6 数値型

ECMAScriptには2つの組み込み数値型、Number型とBigInt型があります。以下の抽象操作がこれらの数値型に対して定義されています。「Result」列は戻り値の型と、ある呼び出しでabrupt completionが返される可能性があるかどうかを示します。

表2: 数値型演算
操作 例(ソース) 評価意味論で呼び出される... 結果
Number::unaryMinus -x 単項-演算子 Number
BigInt::unaryMinus BigInt
Number::bitwiseNOT ~x ビット単位NOT演算子(~ Number
BigInt::bitwiseNOT BigInt
Number::exponentiate x ** y べき乗演算子 および Math.pow ( base, exponent ) Number
BigInt::exponentiate 正常完了(BigIntを含む)またはthrow completion
Number::multiply x * y 乗算演算子 Number
BigInt::multiply BigInt
Number::divide x / y 乗算演算子 Number
BigInt::divide 正常完了(BigIntを含む)またはthrow completion
Number::remainder x % y 乗算演算子 Number
BigInt::remainder 正常完了(BigIntを含む)またはthrow completion
Number::add x ++
++ x
x + y
後置インクリメント演算子, 前置インクリメント演算子, および加算演算子(+ Number
BigInt::add BigInt
Number::subtract x --
-- x
x - y
後置デクリメント演算子, 前置デクリメント演算子, および減算演算子(- Number
BigInt::subtract BigInt
Number::leftShift x << y 左シフト演算子(<< Number
BigInt::leftShift BigInt
Number::signedRightShift x >> y 符号付き右シフト演算子(>> Number
BigInt::signedRightShift BigInt
Number::unsignedRightShift x >>> y 符号なし右シフト演算子(>>> Number
BigInt::unsignedRightShift throw completion
Number::lessThan x < y
x > y
x <= y
x >= y
比較演算子, IsLessThan ( x, y, LeftFirst )経由 Boolean または undefined(比較不能な入力の場合)
BigInt::lessThan Boolean
Number::equal x == y
x != y
x === y
x !== y
等価演算子, IsStrictlyEqual ( x, y )経由 Boolean
BigInt::equal
Number::sameValue Object.is(x, y) オブジェクト内部メソッド, SameValue ( x, y )経由, 厳密な値の等価性テスト用 Boolean
Number::sameValueZero [x].includes(y) SameValueZero ( x, y )経由, Array, Map, Setメソッドで+0𝔽-0𝔽の違いを無視して値の等価性テスト Boolean
Number::bitwiseAND x & y ビット単位バイナリ演算子 Number
BigInt::bitwiseAND BigInt
Number::bitwiseXOR x ^ y Number
BigInt::bitwiseXOR BigInt
Number::bitwiseOR x | y Number
BigInt::bitwiseOR BigInt
Number::toString String(x) 多くの式や組み込み関数、ToString ( argument )経由 String
BigInt::toString

数値型は一般に精度損失や切り捨てなしには変換できないため、ECMAScript言語ではこれらの型間で暗黙的な変換を提供しません。型が異なる関数を呼び出す場合、プログラマはNumberBigInt関数を使って明示的に変換する必要があります。

ECMAScriptの初版および後続版では、特定の演算子に対し、精度損失や切り捨てが生じる暗黙的数値変換が提供されていました。これらのレガシーな暗黙変換は後方互換性のために維持されていますが、BigIntではプログラマの誤りの機会を最小化し、将来版で汎用的な値型を導入する余地を残すために提供されていません。

6.1.6.1 Number型

Number型は、18,437,736,874,454,810,627(すなわち264 - 253 + 3)個の値を持ち、IEEE Standard for Binary Floating-Point Arithmeticで規定される倍精度浮動小数点IEEE 754-2019 binary64値を表します。ただし、IEEE標準の9,007,199,254,740,990(すなわち253 - 2)個の異なるNaN値は、ECMAScriptでは単一の特別なNaN値として表現されます。(NaNはプログラム式NaNで生成されます。)一部の実装では外部コードにより異なるNaN値を検出できる場合もありますが、その挙動は実装定義です。ECMAScriptコードからはすべてのNaN値は区別できません。

Number値をArrayBuffer(25.1)やSharedArrayBuffer(25.2)に格納した後に観測されるビットパターンは、ECMAScript実装で使用されるそのNumber値の内部表現と必ずしも一致しません。

他にも正の無限大+∞𝔽)と負の無限大-∞𝔽)という特別な値があります。(これら2つの無限のNumber値は、プログラム式+Infinity(または単にInfinity)、-Infinityで生成されます。)

その他18,437,736,874,454,810,624(264 - 253)個の値は有限数と呼ばれます。半数が正、半数が負であり、各有限な正のNumber値ごとに同じ大きさの負の値があります。

正のゼロ負のゼロの両方が存在します。(これら2つのゼロ値は、プログラム式+0(または単に0)、-0で生成されます。)

18,437,736,874,454,810,622(264 - 253 - 2)個の有限非ゼロ値は2種類あります:

18,428,729,675,200,069,632(264 - 254)個は正規化され、次の形を持ちます:

s × m × 2e

ここでsは1または-1、m整数で、区間252(含む)~253(含まない)、e整数で、-1074から971の包含区間です。

残りの9,007,199,254,740,990(253 - 2)個の値は非正規化され、次の形を持ちます:

s × m × 2e

ここでsは1または-1、m整数で、区間0(含まない)~252(含まない)、eは-1074です。

大きさが253以下のすべての正負の整数はNumber型で表現可能です。整数0は、Number型において+0𝔽-0𝔽の2種類の表現があります。

有限数値が非ゼロであり、上記の形で表現される整数mが奇数なら「奇数有効桁」、そうでなければ「偶数有効桁」を持ちます。

この仕様の「the Number value for x」という表現(xは正確な実数数学量、πなどの無理数であってもよい)は、次の手順で選ばれたNumber値を意味します。Number型のすべての有限値から-0𝔽を除き、さらに型で表現できない値21024+1 × 253 × 2971)および-21024-1 × 253 × 2971)を加えた集合を考えます。この集合の中でxに最も近い値を選びます。2つの値が同じ距離なら偶数有効桁の方を選びます(2つの追加値も偶数有効桁とみなす)。最終的に21024が選ばれたら+∞𝔽に、-21024が選ばれたら-∞𝔽に、+0𝔽が選ばれたらx < 0のときのみ-0𝔽に、それ以外は選ばれた値をそのまま使います。この結果がNumber value for xです。(この手順はIEEE 754-2019のroundTiesToEvenモードと正確に一致します。)

Number value for +∞は+∞𝔽Number value for -∞は-∞𝔽です。

一部のECMAScript演算子は、特定範囲の整数のみ扱います(例:-231から231-1の包含区間0から216-1の包含区間)。これらの演算子はNumber型の任意の値を受け付け、まず期待範囲の整数値に変換します。数値変換操作の詳細は7.1を参照してください。

6.1.6.1.1 Number::unaryMinus ( x )

抽象操作Number::unaryMinusは、引数x(Number型)を受け取り、Number型を返します。呼び出し時、次の手順を実行します:

  1. xNaNなら、NaNを返す。
  2. xの符号を反転したNumber値(絶対値は同じで符号が逆)を返す。

6.1.6.1.2 Number::bitwiseNOT ( x )

抽象操作Number::bitwiseNOTは、引数x(Number型)を受け取り、整数型Numberを返します。呼び出し時、次の手順を実行します:

  1. oldValueを! ToInt32(x)とする。
  2. oldValueのビット反転を返す。結果の数学値は32ビットの2の補数ビット列として正確に表現可能。

6.1.6.1.3 Number::exponentiate ( base, exponent )

抽象操作Number::exponentiateは、引数base(Number型)とexponent(Number型)を受け取り、Number型を返します。baseexponent乗の結果を表す実装近似値を返します。呼び出し時、次の手順を実行します:

  1. exponentNaNならNaNを返す。
  2. exponent+0𝔽または-0𝔽なら、1𝔽を返す。
  3. baseNaNならNaNを返す。
  4. base+∞𝔽なら、
    1. exponent > +0𝔽なら+∞𝔽を、そうでなければ+0𝔽を返す。
  5. base-∞𝔽なら、
    1. exponent > +0𝔽なら
      1. exponentが奇数整数型Numberなら-∞𝔽を、そうでなければ+∞𝔽を返す。
    2. それ以外の場合
      1. exponentが奇数整数型Numberなら-0𝔽を、そうでなければ+0𝔽を返す。
  6. base+0𝔽なら、
    1. exponent > +0𝔽なら+0𝔽を、そうでなければ+∞𝔽を返す。
  7. base-0𝔽なら、
    1. exponent > +0𝔽なら
      1. exponentが奇数整数型Numberなら-0𝔽を、そうでなければ+0𝔽を返す。
    2. それ以外の場合
      1. exponentが奇数整数型Numberなら-∞𝔽を、そうでなければ+∞𝔽を返す。
  8. Assert: base有限で、+0𝔽でも-0𝔽でもない。
  9. exponent+∞𝔽なら、
    1. abs((base)) > 1なら+∞𝔽を返す。
    2. abs((base)) = 1ならNaNを返す。
    3. abs((base)) < 1なら+0𝔽を返す。
  10. exponent-∞𝔽なら、
    1. abs((base)) > 1なら+0𝔽を返す。
    2. abs((base)) = 1ならNaNを返す。
    3. abs((base)) < 1なら+∞𝔽を返す。
  11. Assert: exponent有限で、+0𝔽でも-0𝔽でもない。
  12. base < -0𝔽かつexponent整数型Numberでなければ、NaNを返す。
  13. 実装近似値のNumber値((base)の(exponent)乗)を返す。

base1𝔽または-1𝔽で、exponent+∞𝔽または-∞𝔽の場合、またはbase1𝔽exponentNaNの場合のbase ** exponentの結果は、IEEE 754-2019と異なります。ECMAScript初版ではこの演算の結果をNaNと規定していましたが、後のIEEE 754では1𝔽となっています。互換性維持のため、ECMAScriptの従来の挙動を残しています。

6.1.6.1.4 Number::multiply ( x, y )

抽象操作Number::multiplyは、引数x(Number型)、y(Number型)を受け取り、Number型を返します。IEEE 754-2019の倍精度浮動小数点演算規則に従い、xyの積を計算します。呼び出し時、次の手順を実行します:

  1. xNaNまたはyNaNなら、NaNを返す。
  2. x+∞𝔽または-∞𝔽なら、
    1. y+0𝔽または-0𝔽なら、NaNを返す。
    2. y > +0𝔽ならxを返す。
    3. それ以外は-xを返す。
  3. y+∞𝔽または-∞𝔽なら、
    1. x+0𝔽または-0𝔽なら、NaNを返す。
    2. x > +0𝔽ならyを返す。
    3. それ以外は-yを返す。
  4. x-0𝔽なら、
    1. y-0𝔽またはy < -0𝔽なら+0𝔽を返す。
    2. それ以外は-0𝔽を返す。
  5. y-0𝔽なら、
    1. x < -0𝔽なら+0𝔽を返す。
    2. それ以外は-0𝔽を返す。
  6. 𝔽((x) × (y))を返す。

有限精度の乗算は可換だが、常に結合則が成り立つわけではありません。

6.1.6.1.5 Number::divide ( x, y )

抽象操作Number::divideは、引数x(Number型)、y(Number型)を受け取り、Number型を返します。IEEE 754-2019の倍精度浮動小数点演算規則に従い、xを被除数、yを除数として商を計算します。呼び出し時、次の手順を実行します:

  1. xNaNまたはyNaNなら、NaNを返す。
  2. x+∞𝔽または-∞𝔽なら、
    1. y+∞𝔽または-∞𝔽なら、NaNを返す。
    2. y+0𝔽またはy > +0𝔽ならxを返す。
    3. それ以外は-xを返す。
  3. y+∞𝔽なら、
    1. x+0𝔽またはx > +0𝔽なら+0𝔽を返す。そうでなければ-0𝔽を返す。
  4. y-∞𝔽なら、
    1. x+0𝔽またはx > +0𝔽なら-0𝔽を返す。そうでなければ+0𝔽を返す。
  5. x+0𝔽または-0𝔽なら、
    1. y+0𝔽または-0𝔽なら、NaNを返す。
    2. y > +0𝔽ならxを返す。
    3. それ以外は-xを返す。
  6. y+0𝔽なら、
    1. x > +0𝔽なら+∞𝔽を返す。そうでなければ-∞𝔽を返す。
  7. y-0𝔽なら、
    1. x > +0𝔽なら-∞𝔽を返す。そうでなければ+∞𝔽を返す。
  8. 𝔽((x) / (y))を返す。

6.1.6.1.6 Number::remainder ( n, d )

抽象操作Number::remainderは、引数n(Number型)、d(Number型)を受け取り、Number型を返します。ここでnは被除数、dは除数であり、暗黙の除算から余りを返します。呼び出し時、次の手順を実行します:

  1. nNaNまたはdNaNならNaNを返す。
  2. n+∞𝔽または-∞𝔽ならNaNを返す。
  3. d+∞𝔽または-∞𝔽ならnを返す。
  4. d+0𝔽または-0𝔽ならNaNを返す。
  5. n+0𝔽または-0𝔽ならnを返す。
  6. Assert: nd有限かつ非ゼロ。
  7. quotient(n) / (d)とする。
  8. qtruncate(quotient)とする。
  9. r(n) - ((d) × q)とする。
  10. r = 0かつn < -0𝔽なら-0𝔽を返す。
  11. 𝔽(r)を返す。
注1

CやC++では余り演算子は整数オペランドのみ受け付けますが、ECMAScriptでは浮動小数点オペランドも受け付けます。

注2
浮動小数点の余り演算(%演算子で計算される)は、IEEE 754-2019で定義される“remainder”演算とは異なります。IEEE規格の“remainder”は丸め除算から余りを計算しますが、これは通常の整数余り演算子と類似しません。ECMAScript言語は、Javaの整数余り演算子と類似するように、浮動小数点演算での%の挙動を定義しています。これはCライブラリ関数fmodと比較できます。

6.1.6.1.7 Number::add ( x, y )

抽象操作Number::addは、引数x(Number型)、y(Number型)を受け取り、Number型を返します。IEEE 754-2019の倍精度浮動小数点演算規則に従い、引数の和を計算します。呼び出し時、次の手順を実行します:

  1. xNaNまたはyNaNなら、NaNを返す。
  2. x+∞𝔽かつy-∞𝔽なら、NaNを返す。
  3. x-∞𝔽かつy+∞𝔽なら、NaNを返す。
  4. x+∞𝔽または-∞𝔽なら、xを返す。
  5. y+∞𝔽または-∞𝔽なら、yを返す。
  6. Assert: xyは両方とも有限
  7. x-0𝔽かつy-0𝔽なら、-0𝔽を返す。
  8. 𝔽((x) + (y))を返す。

有限精度の加算は可換だが、常に結合則が成り立つわけではありません。

6.1.6.1.8 Number::subtract ( x, y )

抽象操作Number::subtractは、引数x(Number型)、y(Number型)を受け取り、Number型を返します。減算を行い、被減数xから減数yを引いた差を返します。呼び出し時、次の手順を実行します:

  1. Number::add(x, Number::unaryMinus(y))を返す。

常にx - yx + (-y)と同じ結果を生成します。

6.1.6.1.9 Number::leftShift ( x, y )

抽象操作Number::leftShiftは、引数x(Number型)、y(Number型)を受け取り、整数型Numberを返します。呼び出し時、次の手順を実行します:

  1. lNumを! ToInt32(x)とする。
  2. rNumを! ToUint32(y)とする。
  3. shiftCount(rNum) modulo 32とする。
  4. lNumshiftCountビット左シフトした結果を返す。結果の数学値は32ビット2の補数ビット列として正確に表現可能。

6.1.6.1.10 Number::signedRightShift ( x, y )

抽象操作Number::signedRightShiftは、引数x(Number型)、y(Number型)を受け取り、整数型Numberを返します。呼び出し時、次の手順を実行します:

  1. lNumを! ToInt32(x)とする。
  2. rNumを! ToUint32(y)とする。
  3. shiftCount(rNum) modulo 32とする。
  4. lNumshiftCountビット符号拡張付き右シフトした結果を返す。最上位ビットは伝播される。結果の数学値は32ビット2の補数ビット列として正確に表現可能。

6.1.6.1.11 Number::unsignedRightShift ( x, y )

抽象操作Number::unsignedRightShiftは、引数x(Number型)、y(Number型)を受け取り、整数型Numberを返します。呼び出し時、次の手順を実行します:

  1. lNumを! ToUint32(x)とする。
  2. rNumを! ToUint32(y)とする。
  3. shiftCount(rNum) modulo 32とする。
  4. lNumshiftCountビットゼロ埋め右シフトした結果を返す。空いたビットはゼロで埋める。結果の数学値は32ビット符号なしビット列として正確に表現可能。

6.1.6.1.12 Number::lessThan ( x, y )

抽象操作Number::lessThanは、引数x(Number型)、y(Number型)を受け取り、Booleanまたはundefinedを返します。呼び出し時、次の手順を実行します:

  1. xNaNならundefinedを返す。
  2. yNaNならundefinedを返す。
  3. xyと等しければfalseを返す。
  4. x+0𝔽かつy-0𝔽ならfalseを返す。
  5. x-0𝔽かつy+0𝔽ならfalseを返す。
  6. x+∞𝔽ならfalseを返す。
  7. y+∞𝔽ならtrueを返す。
  8. y-∞𝔽ならfalseを返す。
  9. x-∞𝔽ならtrueを返す。
  10. Assert: xy有限
  11. (x) < (y)ならtrue、そうでなければfalseを返す。

6.1.6.1.13 Number::equal ( x, y )

抽象操作Number::equalは、引数x(Number型)、y(Number型)を受け取り、Booleanを返します。呼び出し時、次の手順を実行します:

  1. xNaNならfalseを返す。
  2. yNaNならfalseを返す。
  3. xyと等しければtrueを返す。
  4. x+0𝔽かつy-0𝔽ならtrueを返す。
  5. x-0𝔽かつy+0𝔽ならtrueを返す。
  6. falseを返す。

6.1.6.1.14 Number::sameValue ( x, y )

抽象操作Number::sameValueは、引数x(Number型)、y(Number型)を受け取り、Booleanを返します。呼び出し時、次の手順を実行します:

  1. xNaNかつyNaNならtrueを返す。
  2. x+0𝔽かつy-0𝔽ならfalseを返す。
  3. x-0𝔽かつy+0𝔽ならfalseを返す。
  4. xyと等しければtrueを返す。
  5. falseを返す。

6.1.6.1.15 Number::sameValueZero ( x, y )

抽象操作Number::sameValueZeroは、引数x(Number型)、y(Number型)を受け取り、Booleanを返します。呼び出し時、次の手順を実行します:

  1. xNaNかつyNaNならtrueを返す。
  2. x+0𝔽かつy-0𝔽ならtrueを返す。
  3. x-0𝔽かつy+0𝔽ならtrueを返す。
  4. xyと等しければtrueを返す。
  5. falseを返す。

6.1.6.1.16 NumberBitwiseOp ( op, x, y )

抽象操作NumberBitwiseOpは、引数op&^|)、x(Number型)、y(Number型)を受け取り、整数型Numberを返します。呼び出し時、次の手順を実行します:

  1. lNumを! ToInt32(x)とする。
  2. rNumを! ToInt32(y)とする。
  3. lBits(lNum)を表す32ビット2の補数ビット列とする。
  4. rBits(rNum)を表す32ビット2の補数ビット列とする。
  5. op&なら、
    1. resultlBitsrBitsにビットAND演算を適用した結果とする。
  6. そうでなくop^なら、
    1. resultlBitsrBitsにビット排他的OR(XOR)演算を適用した結果とする。
  7. それ以外の場合、
    1. Assert: op|である。
    2. resultlBitsrBitsにビットOR演算を適用した結果とする。
  8. resultで表される32ビット2の補数ビット列の整数に対応するNumber値を返す。

6.1.6.1.17 Number::bitwiseAND ( x, y )

抽象操作Number::bitwiseANDは、引数x(Number型)、y(Number型)を受け取り、整数型Numberを返します。呼び出し時、次の手順を実行します:

  1. NumberBitwiseOp(&, x, y)を返す。

6.1.6.1.18 Number::bitwiseXOR ( x, y )

抽象操作Number::bitwiseXORは、引数x(Number型)、y(Number型)を受け取り、整数型Numberを返します。呼び出し時、次の手順を実行します:

  1. NumberBitwiseOp(^, x, y)を返す。

6.1.6.1.19 Number::bitwiseOR ( x, y )

抽象操作Number::bitwiseORは、引数x(Number型)、y(Number型)を受け取り、整数型Numberを返します。呼び出し時、次の手順を実行します:

  1. NumberBitwiseOp(|, x, y)を返す。

6.1.6.1.20 Number::toString ( x, radix )

抽象操作Number::toStringは、引数x(Number型)、radix整数で、2から36の包含区間内)を受け取り、String型を返します。xを基数radixの位取り記数法で表現したString値として返します。基数rで数字として使うコード単位は、"0123456789abcdefghijklmnopqrstuvwxyz"の先頭r個です。絶対値が1𝔽以上の数値は先頭ゼロを含みません。呼び出し時、次の手順を実行します:

  1. xNaNなら"NaN"を返す。
  2. x+0𝔽または-0𝔽なら"0"を返す。
  3. x < -0𝔽なら、文字列連結"-"Number::toString(-x, radix)を連結して返す。
  4. x+∞𝔽なら"Infinity"を返す。
  5. nks整数とし、k ≥ 1、radixk - 1s < radixk𝔽(s × radixn - k)がxで、kが最小。kは基数radixで表現したsの桁数で、sradixで割り切れず、最下位の桁は一意とは限らないことに注意。
  6. radix ≠ 10またはn-5から21の包含区間なら、
    1. nkなら、
      1. 基数radixで表現したsk桁のコード単位と、n - k個のコード単位0x0030(DIGIT ZERO)を文字列連結して返す。
    2. それ以外でn > 0なら、
      1. 基数radixで表現したsの最上位n桁のコード単位、コード単位0x002E(FULL STOP)、残りk - n桁のコード単位を文字列連結して返す。
    3. それ以外、
      1. Assert: n ≤ 0。
      2. コード単位0x0030(DIGIT ZERO)、コード単位0x002E(FULL STOP)、-n個のコード単位0x0030(DIGIT ZERO)、基数radixで表現したsk桁のコード単位を文字列連結して返す。
  7. この場合、入力は科学的E表記(例:1.2e+3)で表現される。
  8. Assert: radixは10。
  9. n < 0なら、
    1. exponentSignをコード単位0x002D(HYPHEN-MINUS)とする。
  10. それ以外、
    1. exponentSignをコード単位0x002B(PLUS SIGN)とする。
  11. k = 1なら、
    1. 1桁のコード単位、コード単位0x0065(LATIN SMALL LETTER E)、exponentSignabs(n - 1)の10進表現のコード単位を文字列連結して返す。
  12. 最上位の10進桁のコード単位、コード単位0x002E(FULL STOP)、残りk - 1桁の10進表現のコード単位、コード単位0x0065(LATIN SMALL LETTER E)、exponentSignabs(n - 1)の10進表現のコード単位を文字列連結して返す。
注1

以下の観察事項は実装ガイドラインとして有用ですが、標準の規範要件ではありません:

  • xが-0𝔽以外の任意のNumber値であれば、ToNumber(ToString(x))はxである。
  • 5で示された要件では最下位桁は一意に定まらない場合がある。
注2

上記の規則よりも高精度な変換を提供する実装では、以下の代替バージョンの5がガイドラインとして推奨されます:

  1. nks整数とし、k ≥ 1、radixk - 1s < radixk𝔽(s × radixn - k)がxで、kが最小。sに複数の候補がある場合は、s × radixn - k(x)に最も近い値を選択し、2つある場合は偶数を選ぶ。kは基数radixの桁数で、sradixで割り切れないことに注意。
注3

ECMAScriptの実装者にはDavid M. Gayが書いた浮動小数点数の2進-10進変換の論文とコードが有用かもしれません:

Gay, David M. Correctly Rounded Binary-Decimal and Decimal-Binary Conversions. Numerical Analysis, Manuscript 90-10. AT&T Bell Laboratories (Murray Hill, New Jersey). 1990年11月30日。
https://ampl.com/_archive/first-website/REFS/rounding.pdf
関連コードは
http://netlib.sandia.gov/fp/dtoa.c および
http://netlib.sandia.gov/fp/g_fmt.c にあり、他のnetlibミラーサイトにもあります。

6.1.6.2 BigInt型

BigInt型は、整数値を表します。値は任意のサイズで、特定のビット幅に制限されません。特に記載がなければ、演算は正確な数学的結果を返すよう設計されています。2項演算では、BigIntは2の補数のバイナリ文字列として動作し、負の数は左側に無限にビットが立っているものとして扱われます。

6.1.6.2.1 BigInt::unaryMinus ( x )

抽象操作BigInt::unaryMinusは引数x(BigInt型)を受け取り、BigInt型を返します。呼び出し時、次の手順を実行します:

  1. x = 0なら0を返す。
  2. -xを返す。

6.1.6.2.2 BigInt::bitwiseNOT ( x )

抽象操作BigInt::bitwiseNOTは引数x(BigInt型)を受け取り、BigInt型を返します。xの1の補数を返します。呼び出し時、次の手順を実行します:

  1. -x - 1を返す。

6.1.6.2.3 BigInt::exponentiate ( base, exponent )

抽象操作BigInt::exponentiateは引数base(BigInt型)、exponent(BigInt型)を受け取り、正常完了(BigIntを含む)またはthrow completionを返します。呼び出し時、次の手順を実行します:

  1. exponent < 0ならRangeError例外を投げる。
  2. base = 0かつexponent = 0なら1を返す。
  3. baseexponent乗を返す。

6.1.6.2.4 BigInt::multiply ( x, y )

抽象操作BigInt::multiplyは引数x(BigInt型)、y(BigInt型)を受け取り、BigInt型を返します。呼び出し時、次の手順を実行します:

  1. x × yを返す。
結果が入力より遥かに大きなビット幅を持つ場合も、正確な数学解が返されます。

6.1.6.2.5 BigInt::divide ( x, y )

抽象操作BigInt::divideは引数x(BigInt型)、y(BigInt型)を受け取り、正常完了(BigIntを含む)またはthrow completionを返します。呼び出し時、次の手順を実行します:

  1. y = 0ならRangeError例外を投げる。
  2. quotient(x) / (y)とする。
  3. (truncate(quotient))を返す。

6.1.6.2.6 BigInt::remainder ( n, d )

抽象操作BigInt::remainderは引数n(BigInt型)、d(BigInt型)を受け取り、正常完了(BigIntを含む)またはthrow completionを返します。呼び出し時、次の手順を実行します:

  1. d = 0ならRangeError例外を投げる。
  2. n = 0なら0を返す。
  3. quotient(n) / (d)とする。
  4. q(truncate(quotient))とする。
  5. n - (d × q)を返す。
結果の符号は被除数の符号になります。

6.1.6.2.7 BigInt::add ( x, y )

抽象操作BigInt::addは引数x(BigInt型)、y(BigInt型)を受け取り、BigInt型を返します。呼び出し時、次の手順を実行します:

  1. x + yを返す。

6.1.6.2.8 BigInt::subtract ( x, y )

抽象操作BigInt::subtractは引数x(BigInt型)、y(BigInt型)を受け取り、BigInt型を返します。呼び出し時、次の手順を実行します:

  1. x - yを返す。

6.1.6.2.9 BigInt::leftShift ( x, y )

抽象操作BigInt::leftShiftは引数x(BigInt型)、y(BigInt型)を受け取り、BigInt型を返します。呼び出し時、次の手順を実行します:

  1. y < 0なら、
    1. (floor((x) / 2-(y)))を返す。
  2. x × 2yを返す。
ここでの意味論は、BigIntを無限長の2の補数バイナリ列としてビットシフトした場合と同等です。

6.1.6.2.10 BigInt::signedRightShift ( x, y )

抽象操作BigInt::signedRightShiftは引数x(BigInt型)、y(BigInt型)を受け取り、BigInt型を返します。呼び出し時、次の手順を実行します:

  1. BigInt::leftShift(x, -y)を返す。

6.1.6.2.11 BigInt::unsignedRightShift ( x, y )

抽象操作BigInt::unsignedRightShiftは引数x(BigInt型)、y(BigInt型)を受け取り、throw completionを返します。呼び出し時、次の手順を実行します:

  1. TypeError例外を投げる。

6.1.6.2.12 BigInt::lessThan ( x, y )

抽象操作BigInt::lessThanは引数x(BigInt型)、y(BigInt型)を受け取り、Boolean型を返します。呼び出し時、次の手順を実行します:

  1. (x) < (y)ならtrue、そうでなければfalseを返す。

6.1.6.2.13 BigInt::equal ( x, y )

抽象操作BigInt::equalは引数x(BigInt型)、y(BigInt型)を受け取り、Boolean型を返します。呼び出し時、次の手順を実行します:

  1. (x) = (y)ならtrue、そうでなければfalseを返す。

6.1.6.2.14 BinaryAnd ( x, y )

抽象操作BinaryAndは引数x(0または1)、y(0または1)を受け取り、0または1を返します。呼び出し時、次の手順を実行します:

  1. x = 1かつy = 1なら1を返す。
  2. それ以外は0を返す。

6.1.6.2.15 BinaryOr ( x, y )

抽象操作BinaryOrは引数x(0または1)、y(0または1)を受け取り、0または1を返します。呼び出し時、次の手順を実行します:

  1. x = 1またはy = 1なら1を返す。
  2. それ以外は0を返す。

6.1.6.2.16 BinaryXor ( x, y )

抽象操作BinaryXorは引数x(0または1)、y(0または1)を受け取り、0または1を返します。呼び出し時、次の手順を実行します:

  1. x = 1かつy = 0なら1を返す。
  2. それ以外でx = 0かつy = 1なら1を返す。
  3. それ以外は0を返す。

6.1.6.2.17 BigIntBitwiseOp ( op, x, y )

抽象操作BigIntBitwiseOpは、引数op&^|)、x(BigInt型)、y(BigInt型)を受け取り、BigInt型を返します。呼び出し時、次の手順を実行します:

  1. x(x)に設定する。
  2. y(y)に設定する。
  3. resultを0に設定する。
  4. shiftを0に設定する。
  5. 次を満たすまで繰り返す:(x = 0またはx = -1)かつ(y = 0またはy = -1)
    1. xDigitx modulo 2とする。
    2. yDigity modulo 2とする。
    3. op&なら、
      1. resultresult + 2shift × BinaryAnd(xDigit, yDigit)に設定する。
    4. それ以外でop|なら、
      1. resultresult + 2shift × BinaryOr(xDigit, yDigit)に設定する。
    5. それ以外の場合、
      1. Assert: op^である。
      2. resultresult + 2shift × BinaryXor(xDigit, yDigit)に設定する。
    6. shiftshift + 1に設定する。
    7. xを(x - xDigit) / 2に設定する。
    8. yを(y - yDigit) / 2に設定する。
  6. op&なら、
    1. tmpBinaryAnd(x modulo 2, y modulo 2)に設定する。
  7. それ以外でop|なら、
    1. tmpBinaryOr(x modulo 2, y modulo 2)に設定する。
  8. それ以外の場合、
    1. Assert: op^である。
    2. tmpBinaryXor(x modulo 2, y modulo 2)に設定する。
  9. tmp ≠ 0なら、
    1. resultresult - 2shiftに設定する。
    2. 注:これは符号拡張を行います。
  10. resultBigInt値を返す。

6.1.6.2.18 BigInt::bitwiseAND ( x, y )

抽象操作BigInt::bitwiseANDは引数x(BigInt型)、y(BigInt型)を受け取り、BigInt型を返します。呼び出し時、次の手順を実行します:

  1. BigIntBitwiseOp(&, x, y)を返す。

6.1.6.2.19 BigInt::bitwiseXOR ( x, y )

抽象操作BigInt::bitwiseXORは引数x(BigInt型)、y(BigInt型)を受け取り、BigInt型を返します。呼び出し時、次の手順を実行します:

  1. BigIntBitwiseOp(^, x, y)を返す。

6.1.6.2.20 BigInt::bitwiseOR ( x, y )

抽象操作BigInt::bitwiseORは引数x(BigInt型)、y(BigInt型)を受け取り、BigInt型を返します。呼び出し時、次の手順を実行します:

  1. BigIntBitwiseOp(|, x, y)を返す。

6.1.6.2.21 BigInt::toString ( x, radix )

抽象操作BigInt::toStringは引数x(BigInt型)、radix整数で、2から36の包含区間内)を受け取り、String型を返します。xを基数radixの位取り記数法で表現したString値として返します。基数rで数字として使うコード単位は、"0123456789abcdefghijklmnopqrstuvwxyz"の先頭r個です。0以外のBigInt表現は先頭ゼロを含みません。呼び出し時、次の手順を実行します:

  1. x < 0なら、文字列連結"-"BigInt::toString(-x, radix)を連結して返す。
  2. 基数radixで表現したxのString値を返す。

6.1.7 オブジェクト型

Object型の各インスタンス(単に「オブジェクト」とも呼ばれる)は、プロパティの集合を表します。各プロパティはデータプロパティまたはアクセサプロパティのいずれかです:

  • データプロパティは、キー値をECMAScript言語値とBoolean属性の集合に関連付けます。
  • アクセサプロパティは、キー値を1つまたは2つのアクセサ関数とBoolean属性の集合に関連付けます。アクセサ関数は、そのプロパティに関連付けられたECMAScript言語値の格納や取得に使われます。

オブジェクトのプロパティはプロパティキーで一意に識別されます。プロパティキーはStringまたはSymbolです。空文字列を含むすべてのStringおよびSymbolはプロパティキーとして有効です。プロパティ名は、プロパティキーで、String型であるものです。

整数インデックスは、プロパティ名nで、CanonicalNumericIndexString(n) が整数型Numberで、+0𝔽から𝔽(253 - 1)までの包含区間にあるものです。配列インデックスは、整数インデックスnで、CanonicalNumericIndexString(n) が整数型Numberで、+0𝔽から𝔽(232 - 2)までの包含区間にあるものです。

すべての非負の安全な整数には対応する整数インデックスがあります。すべての32ビット符号なし整数(ただし232 - 1を除く)には対応する配列インデックスがあります。"-0"整数インデックスでも配列インデックスでもありません。

プロパティキーはプロパティやその値へのアクセスに使われます。プロパティへのアクセスにはgetsetの2種類があり、それぞれ値の取得と代入に対応します。get/setアクセス可能なプロパティには、オブジェクト自身が直接持つ所有プロパティと、他の関連オブジェクトから継承される継承プロパティの両方が含まれます。継承プロパティは、関連オブジェクトの所有プロパティまたはその継承プロパティのいずれかです。オブジェクトの各所有プロパティは、他の所有プロパティのキー値とは異なるキー値を持たなければなりません。

すべてのオブジェクトは論理的にプロパティの集合ですが、プロパティのアクセスや操作の意味論が異なる複数の形式のオブジェクトが存在します。詳細は6.1.7.2を参照してください。

さらに、一部のオブジェクトは呼び出し可能であり、これらは関数または関数オブジェクトと呼ばれ、後述で説明されます。ECMAScriptのすべての関数はObject型のメンバーです。

6.1.7.1 プロパティ属性

属性は、この仕様でObjectプロパティの状態を定義・説明するために使用されます(表3参照)。明示的な指定がない限り、各属性の初期値はデフォルト値です。

表3: オブジェクトプロパティの属性
属性名 属性が存在するプロパティの種類 値のドメイン デフォルト値 説明
[[Value]] データプロパティ ECMAScript言語値 undefined getアクセスで取得されるプロパティの値。
[[Writable]] データプロパティ Boolean false falseの場合、ECMAScriptコードによる[[Set]][[Value]]属性を変更しようとしても成功しません。
[[Get]] アクセサプロパティ Object または undefined undefined 値がObjectの場合は関数オブジェクトでなければなりません。関数の[[Call]]内部メソッド(表5)が引数なしで呼び出され、プロパティ値を取得します。
[[Set]] アクセサプロパティ Object または undefined undefined 値がObjectの場合は関数オブジェクトでなければなりません。関数の[[Call]]内部メソッド(表5)が、代入値を唯一の引数とする引数リストで呼び出されます。[[Set]]の効果は、必須ではありませんが、以降の[[Get]]の結果に影響する場合があります。
[[Enumerable]] データプロパティまたは アクセサプロパティ Boolean false trueの場合、このプロパティはfor-in列挙(14.7.5参照)で列挙されます。それ以外の場合、非列挙プロパティとみなされます。
[[Configurable]] データプロパティまたは アクセサプロパティ Boolean false falseの場合、プロパティの削除、データプロパティからアクセサプロパティへの変更、またはその逆、既存[[Value]]の置き換えや[[Writable]]falseに設定する以外の属性変更は失敗します。

6.1.7.2 オブジェクトの内部メソッドと内部スロット

ECMAScriptにおけるオブジェクトの実際の意味論は、内部メソッドと呼ばれるアルゴリズムによって規定されます。ECMAScriptエンジンの各オブジェクトには、その実行時の挙動を定義する内部メソッドの集合が関連付けられています。これらの内部メソッドはECMAScript言語の一部ではありません。本仕様で説明目的のみで定義されます。ただし、ECMAScriptの各実装におけるオブジェクトは、その関連付けられた内部メソッドで規定されたとおりに動作しなければなりません。その実現方法の詳細は実装によって決まります。

内部メソッド名はポリモーフィックです。つまり、同じ内部メソッド名を呼び出しても、異なるオブジェクト値ごとに異なるアルゴリズムが実行される場合があります。内部メソッドが呼び出される実際のオブジェクトを「ターゲット」と呼びます。実行時に、あるアルゴリズムがオブジェクトのサポートしない内部メソッドを使おうとした場合、TypeError例外がスローされます。

内部スロットは、オブジェクトに関連付けられ、ECMAScript仕様のさまざまなアルゴリズムで使われる内部状態を表します。内部スロットはオブジェクトのプロパティではなく、継承もされません。各内部スロット仕様によっては、その状態はどのECMAScript言語型や特定のECMAScript仕様型値でもかまいません。特に指定がなければ、内部スロットはオブジェクト生成時に割り当てられ、動的に追加することはできません。特に指定がなければ、内部スロットの初期値はundefinedです。本仕様内のさまざまなアルゴリズムで内部スロットを持つオブジェクトが作られますが、ECMAScript言語では内部スロットを直接オブジェクトに関連付ける方法はありません。

すべてのオブジェクトには[[PrivateElements]]という名前の内部スロットがあり、これはList型で、PrivateElementsが入ります。このListは、そのオブジェクトのプライベートフィールド・メソッド・アクセサの値を表します。初期状態では空のListです。

内部メソッドと内部スロットは、この仕様では[[ ]]で囲まれた名前で示されます。

表4は、ECMAScriptコードにより作成または操作されるすべてのオブジェクトに適用される、本仕様で使用される本質的内部メソッドをまとめたものです。すべてのオブジェクトは、すべての本質的内部メソッドに対するアルゴリズムを持たなければなりません。ただし、すべてのオブジェクトがそれらすべてに同じアルゴリズムを使うとは限りません。

通常のオブジェクトとは、次の条件をすべて満たすオブジェクトです:

  • 表4に挙げた内部メソッドについて、そのオブジェクトは10.1で定義されたものを使う。
  • オブジェクトが[[Call]]内部メソッドを持つ場合、それは10.2.1または10.3.1で定義されたもののいずれかを使う。
  • オブジェクトが[[Construct]]内部メソッドを持つ場合、それは10.2.2または10.3.2で定義されたもののいずれかを使う。

エキゾチックオブジェクトとは、通常のオブジェクトでないオブジェクトです。

本仕様では、エキゾチックオブジェクトの種類ごとに、そのオブジェクトの内部メソッドで区別しています。特定の種類のエキゾチックオブジェクト(例えば配列エキゾチックオブジェクトバウンド関数エキゾチックオブジェクト)と動作上同等でも、当該種類で規定された内部メソッド群を持たなければ、その種類のエキゾチックオブジェクトとは認められません。

表4や類似表の「Signature」列では、各内部メソッドの呼び出しパターンを記載しています。呼び出しパターンには常にパラメータ名の括弧付きリストが含まれます。パラメータ名がECMAScript型名と同じ場合、その値の型を示します。内部メソッドが明示的に値を返す場合、パラメータリストの後に「→」と戻り値型を記載します。型名は6節で定義された型に、以下の追加型を加えたものです。「any」は任意のECMAScript言語型であることを意味します。

内部メソッドは、パラメータに加えて、常に呼び出し対象のオブジェクト自身にアクセスできます。

内部メソッドは暗黙的にCompletion Recordを返します。これは、呼び出しパターンで示す戻り値型を包んだnormal completionか、throw completionのいずれかです。

表4: 本質的内部メソッド
内部メソッド シグネチャ 説明
[[GetPrototypeOf]] ( ) Object | Null このオブジェクトに継承プロパティを提供するオブジェクトを決定する。null値は継承プロパティが存在しないことを示す。
[[SetPrototypeOf]] (Object | Null) Boolean このオブジェクトに継承プロパティを提供する別のオブジェクトを関連付ける。nullを渡すと継承プロパティがないことになる。操作が成功した場合はtrue、失敗した場合はfalseを返す。
[[IsExtensible]] ( ) Boolean このオブジェクトに追加プロパティを追加できるかどうかを判定する。
[[PreventExtensions]] ( ) Boolean このオブジェクトに新たなプロパティを追加できるかどうかを制御する。操作が成功したらtrue、失敗したらfalseを返す。
[[GetOwnProperty]] (propertyKey) Undefined | Property Descriptor このオブジェクトの所有プロパティでキーがpropertyKeyであるものについて、Property Descriptorを返す。該当プロパティがなければundefinedを返す。
[[DefineOwnProperty]] (propertyKey, PropertyDescriptor) Boolean キーがpropertyKeyの所有プロパティをPropertyDescriptorで記述される状態に新規作成または変更する。プロパティの作成・更新に成功した場合はtrue、失敗した場合はfalseを返す。
[[HasProperty]] (propertyKey) Boolean このオブジェクトが既に所有または継承するキーpropertyKeyのプロパティを持つかどうかを示すBoolean値を返す。
[[Get]] (propertyKey, Receiver) any このオブジェクトからキーpropertyKeyのプロパティ値を返す。プロパティ値の取得にECMAScriptコードの実行が必要な場合、Receiverthis値として使われる。
[[Set]] (propertyKey, value, Receiver) Boolean このオブジェクトのキーpropertyKeyのプロパティ値をvalueに設定する。値の設定にECMAScriptコードの実行が必要な場合、Receiverthis値として使われる。値の設定に成功したらtrue、失敗したらfalseを返す。
[[Delete]] (propertyKey) Boolean このオブジェクトからキーpropertyKeyの所有プロパティを削除する。削除できなかった場合(まだ存在する場合)はfalse、削除できた場合またはプロパティが存在しない場合はtrueを返す。
[[OwnPropertyKeys]] ( ) List of property keys オブジェクトのすべての所有プロパティキーを要素とするListを返す。

表5は、関数として呼び出し可能なオブジェクトがサポートする追加の本質的内部メソッドをまとめたものです。関数オブジェクト[[Call]]内部メソッドをサポートするオブジェクトです。コンストラクタ[[Construct]]内部メソッドをサポートするオブジェクトです。[[Construct]]をサポートするすべてのオブジェクトは[[Call]]もサポートしなければなりません。つまり、すべてのコンストラクタ関数オブジェクトでなければなりません。したがって、コンストラクタコンストラクタ関数またはコンストラクタ関数オブジェクトとも呼ばれます。

表5: 関数オブジェクトの追加本質的内部メソッド
内部メソッド シグネチャ 説明
[[Call]] (any, any型のList) any このオブジェクトに関連するコードを実行する。関数呼び出し式を介して呼び出される。内部メソッドの引数はthis値と、呼び出し式で関数に渡された引数を要素とするList。この内部メソッドを実装するオブジェクトは呼び出し可能である。
[[Construct]] (any型のList, Object) Object オブジェクトを生成する。new演算子またはsuper呼び出しで呼ばれる。内部メソッドの第1引数はコンストラクタ呼び出しまたはsuper呼び出しの引数を要素とするList。第2引数はnew演算子が最初に適用されたオブジェクト。これを実装するオブジェクトはコンストラクタと呼ばれる。関数オブジェクトが必ずしもコンストラクタとは限らず、コンストラクタでない関数オブジェクト[[Construct]]内部メソッドを持ちません。

通常のオブジェクトおよび標準的な エキゾチックオブジェクトの本質的内部メソッドの意味論は、10節で規定されています。エキゾチックオブジェクトの内部メソッドの指定された使用が実装でサポートされていない場合、その使用を試みるとTypeError例外をスローしなければなりません。

6.1.7.3 本質的内部メソッドの不変条件

ECMAScriptエンジンのオブジェクトの内部メソッドは、以下に指定する不変条件を満たさなければなりません。本仕様の通常のECMAScriptオブジェクトおよびすべての標準エキゾチックオブジェクトはこれらの不変条件を維持します。ECMAScript Proxyオブジェクトは、[[ProxyHandler]]オブジェクト上のトラップ呼び出し結果に対する実行時チェックによって、これらの不変条件を維持します。

実装で提供されるエキゾチックオブジェクトも、それらについてこれらの不変条件を維持しなければなりません。不変条件違反は、ECMAScriptコードが予測不可能な動作をしたり、セキュリティ上の問題を引き起こす可能性があります。しかし、不変条件の違反によって実装のメモリ安全性が損なわれてはなりません。

実装は、必須内部メソッドの機能を不変条件を強制せずに別のインターフェースで提供するといった手段で、これらの不変条件を回避できるようにしてはなりません。

定義:

  • 内部メソッドのターゲットとは、その内部メソッドが呼び出されるオブジェクトです。
  • ターゲットの[[IsExtensible]]内部メソッドがfalseを返した、または[[PreventExtensions]]内部メソッドがtrueを返したことが観測された場合、ターゲットは拡張不可(non-extensible)です。
  • 存在しない(non-existent)プロパティとは、拡張不可ターゲットの所有プロパティとして存在しないプロパティです。
  • SameValueへのすべての参照は、SameValueアルゴリズムの定義によります。

戻り値:

いかなる内部メソッドが返す値も、以下のいずれかのCompletion Recordでなければなりません:

  • [[Type]] = normal[[Target]] = empty[[Value]] = 下記に示すその内部メソッドの「通常の戻り値型」の値、または
  • [[Type]] = throw[[Target]] = empty[[Value]] = 任意のECMAScript言語値
注1

内部メソッドはcontinue completionbreak completionreturn completionを返してはなりません。

[[GetPrototypeOf]] ( )

  • 通常の戻り値型はObjectまたはNullです。
  • ターゲットが拡張不可で[[GetPrototypeOf]]が値Vを返した場合、以後の[[GetPrototypeOf]]呼び出しもSameValueとしてVを返すべきです。
注2

オブジェクトのプロトタイプチェーンは有限長であるべきです(すなわち、任意のオブジェクトから再帰的に[[GetPrototypeOf]]内部メソッドを適用していけば最終的にnullに到達する)が、プロトタイプチェーンに通常のオブジェクトの定義によらないエキゾチックオブジェクトが含まれる場合、この要件はオブジェクトレベルの不変条件として強制できません。そのような循環プロトタイプチェーンは、プロパティアクセス時に無限ループを引き起こすことがあります。

[[SetPrototypeOf]] ( V )

  • 通常の戻り値型はBooleanです。
  • ターゲットが拡張不可の場合、Vがターゲットの観測された[[GetPrototypeOf]]値とSameValueでない限り、[[SetPrototypeOf]]falseを返さなければなりません。

[[IsExtensible]] ( )

  • 通常の戻り値型はBooleanです。
  • [[IsExtensible]]falseを返した場合、それ以降のターゲットへの[[IsExtensible]]呼び出しはすべてfalseを返さなければなりません。

[[PreventExtensions]] ( )

  • 通常の戻り値型はBooleanです。
  • [[PreventExtensions]]trueを返した場合、それ以降のターゲットへの[[IsExtensible]]呼び出しはすべてfalseを返し、ターゲットは拡張不可とみなされます。

[[GetOwnProperty]] ( P )

  • 通常の戻り値型はProperty DescriptorまたはUndefinedです。
  • 戻り値がProperty Descriptorの場合、それは完全なProperty Descriptorでなければなりません。
  • Pが非設定可能かつ非書換可能な所有データプロパティである場合、以後の[[GetOwnProperty]](P)呼び出しは、[[Value]]SameValueP[[Value]]属性と一致するProperty Descriptorを返さなければなりません。
  • P[[Writable]][[Value]]以外の属性が将来変更される、またはプロパティが削除される可能性がある場合、[[Configurable]]属性はtrueでなければなりません。
  • [[Writable]]属性がfalseからtrueに将来変更される可能性がある場合、[[Configurable]]属性はtrueでなければなりません。
  • ターゲットが拡張不可でPが存在しない場合、以後のターゲットへの[[GetOwnProperty]](P)呼び出しはPが存在しないものとして記述しなければなりません(つまり[[GetOwnProperty]](P)はundefinedを返さなければなりません)。
注3

第3不変条件の帰結として、プロパティがデータプロパティであり、値が将来変化する可能性がある場合は、他の本質的内部メソッドで値の変更機構が提供されていなくても、[[Writable]][[Configurable]]属性のいずれかまたは両方がtrueでなければなりません。

[[DefineOwnProperty]] ( P, Desc )

  • 通常の戻り値型はBooleanです。
  • [[DefineOwnProperty]]は、Pが以前に非設定可能な所有プロパティとして観測されていた場合、次のいずれかを除きfalseを返さなければなりません:
    1. Pが書き換え可能なデータプロパティである。非設定可能な書き換え可能データプロパティは、非設定可能な非書き換え可能データプロパティに変更できる。
    2. Descのすべての属性がPの属性とSameValueである。
  • [[DefineOwnProperty]](P, Desc)は、ターゲットが拡張不可かつPが存在しない所有プロパティの場合falseを返さなければなりません。つまり、拡張不可なターゲットオブジェクトは新たなプロパティで拡張できません。

[[HasProperty]] ( P )

  • 通常の戻り値型はBooleanです。
  • Pが以前にターゲットの非設定可能な所有データまたはアクセサプロパティとして観測されていた場合、[[HasProperty]]trueを返さなければなりません。

[[Get]] ( P, Receiver )

  • 通常の戻り値型はECMAScript言語型です。
  • Pが以前にターゲットの非設定可能・非書換可能な所有データプロパティで値Vを持つと観測されていた場合、[[Get]]VSameValueな値を返さなければなりません。
  • Pが以前にターゲットの非設定可能な所有アクセサプロパティで、その[[Get]]属性がundefinedだった場合、[[Get]]操作はundefinedを返さなければなりません。

[[Set]] ( P, V, Receiver )

  • 通常の戻り値型はBooleanです。
  • Pが以前にターゲットの非設定可能・非書換可能な所有データプロパティであった場合、[[Set]]VP[[Value]]属性とSameValueでない限りfalseを返さなければなりません。
  • Pが以前にターゲットの非設定可能な所有アクセサプロパティで、その[[Set]]属性がundefinedだった場合、[[Set]]操作はfalseを返さなければなりません。

[[Delete]] ( P )

  • 通常の戻り値型はBooleanです。
  • Pが以前にターゲットの非設定可能な所有データまたはアクセサプロパティであった場合、[[Delete]]falseを返さなければなりません。

[[OwnPropertyKeys]] ( )

  • 通常の戻り値型はListです。
  • 返されるListには重複要素があってはなりません。
  • 返されるListの各要素は、プロパティキーでなければなりません。
  • 返されるListには、これまでに観測されたすべての非設定可能な所有プロパティのキーが少なくとも含まれていなければなりません。
  • ターゲットが拡張不可の場合、返されるListには[[GetOwnProperty]]で観測可能なターゲットのすべての所有プロパティのキーのみが含まれていなければなりません。

[[Call]] ( )

[[Construct]] ( )

  • 通常の戻り値型はObjectです。
  • ターゲットは[[Call]]内部メソッドも持っていなければなりません。

6.1.7.4 よく知られた組み込みオブジェクト

よく知られた組み込みオブジェクトは、この仕様書のアルゴリズムで明示的に参照される組み込みオブジェクトであり、通常はrealm固有の識別子を持ちます。特に指定がない限り、各組み込みオブジェクトは実際には似たオブジェクトのセットに対応しており、realmごとに1つ存在します。

この仕様書内では、%name% のような参照は、現在のrealmに関連付けられた、nameに対応する組み込みオブジェクトを意味します。%name.a.b% のような参照は、ECMAScriptコードが評価される前に、組み込みオブジェクト %name% の "a" プロパティの値の "b" プロパティにアクセスしたかのような意味になります。現在のrealmおよびその組み込みオブジェクトの決定方法については、9.4で説明されています。よく知られた組み込みオブジェクトは、表6に一覧されています。

表6: よく知られた組み込みオブジェクト
組み込み名 グローバル名 ECMAScript 言語の関連付け
%AggregateError% AggregateError AggregateErrorコンストラクター20.5.7.1
%Array% Array Array の コンストラクター23.1.1
%ArrayBuffer% ArrayBuffer ArrayBuffer の コンストラクター25.1.4
%ArrayIteratorPrototype% Array Iterator オブジェクト のプロトタイプ(23.1.5
%AsyncFromSyncIteratorPrototype% Async-from-Sync Iterator オブジェクト のプロトタイプ(27.1.6
%AsyncFunction% 非同期関数オブジェクトコンストラクター27.7.1
%AsyncGeneratorFunction% 非同期ジェネレーター関数オブジェクトコンストラクター27.4.1
%AsyncGeneratorPrototype% 非同期ジェネレーターオブジェクトのプロトタイプ(27.6
%AsyncIteratorPrototype% すべての標準ビルトイン非同期イテレーターオブジェクトが間接的に継承するオブジェクト
%Atomics% Atomics Atomics オブジェクト(25.4
%BigInt% BigInt BigInt の コンストラクター21.2.1
%BigInt64Array% BigInt64Array BigInt64Array の コンストラクター23.2
%BigUint64Array% BigUint64Array BigUint64Array の コンストラクター23.2
%Boolean% Boolean Boolean の コンストラクター20.3.1
%DataView% DataView DataView の コンストラクター25.3.2
%Date% Date Date の コンストラクター21.4.2
%decodeURI% decodeURI decodeURI 関数(19.2.6.1
%decodeURIComponent% decodeURIComponent decodeURIComponent 関数(19.2.6.2
%encodeURI% encodeURI encodeURI 関数(19.2.6.3
%encodeURIComponent% encodeURIComponent encodeURIComponent 関数(19.2.6.4
%Error% Error Error の コンストラクター20.5.1
%eval% eval eval 関数(19.2.1
%EvalError% EvalError EvalError の コンストラクター20.5.5.1
%FinalizationRegistry% FinalizationRegistry FinalizationRegistryコンストラクター26.2.1
%Float16Array% Float16Array Float16Array の コンストラクター23.2
%Float32Array% Float32Array Float32Array の コンストラクター23.2
%Float64Array% Float64Array Float64Array の コンストラクター23.2
%ForInIteratorPrototype% For-In Iterator オブジェクト のプロトタイプ(14.7.5.10
%Function% Function Function の コンストラクター20.2.1
%GeneratorFunction% ジェネレーター関数オブジェクトコンストラクター27.3.1
%GeneratorPrototype% ジェネレーターオブジェクトのプロトタイプ(27.5
%Int8Array% Int8Array Int8Array の コンストラクター23.2
%Int16Array% Int16Array Int16Array の コンストラクター23.2
%Int32Array% Int32Array Int32Array の コンストラクター23.2
%isFinite% isFinite isFinite 関数(19.2.2
%isNaN% isNaN isNaN 関数(19.2.3
%Iterator% Iterator Iteratorコンストラクター27.1.3.1
%IteratorHelperPrototype% Iterator Helper オブジェクト のプロトタイプ(27.1.2.1
%JSON% JSON JSON オブジェクト(25.5
%Map% Map Map の コンストラクター24.1.1
%MapIteratorPrototype% Map Iterator オブジェクト のプロトタイプ(24.1.5
%Math% Math Math オブジェクト(21.3
%Number% Number Number の コンストラクター21.1.1
%Object% Object Object の コンストラクター20.1.1
%parseFloat% parseFloat parseFloat 関数(19.2.4
%parseInt% parseInt parseInt 関数(19.2.5
%Promise% Promise Promise の コンストラクター27.2.3
%Proxy% Proxy Proxy の コンストラクター28.2.1
%RangeError% RangeError RangeError の コンストラクター20.5.5.2
%ReferenceError% ReferenceError ReferenceError の コンストラクター20.5.5.3
%Reflect% Reflect Reflect オブジェクト(28.1
%RegExp% RegExp RegExp の コンストラクター22.2.4
%RegExpStringIteratorPrototype% RegExp String Iterator オブジェクト のプロトタイプ(22.2.9
%Set% Set Set の コンストラクター24.2.2
%SetIteratorPrototype% Set Iterator オブジェクト のプロトタイプ(24.2.6
%SharedArrayBuffer% SharedArrayBuffer SharedArrayBuffer の コンストラクター25.2.3
%String% String String の コンストラクター22.1.1
%StringIteratorPrototype% String Iterator オブジェクト のプロトタイプ(22.1.5
%Symbol% Symbol Symbol の コンストラクター20.4.1
%SyntaxError% SyntaxError SyntaxError の コンストラクター20.5.5.4
%ThrowTypeError% 常に新しい %TypeError% をスローする 関数オブジェクト
%TypedArray% すべての型付き配列の コンストラクター のスーパークラス(23.2.1
%TypeError% TypeError TypeError の コンストラクター20.5.5.5
%Uint8Array% Uint8Array Uint8Array の コンストラクター23.2
%Uint8ClampedArray% Uint8ClampedArray Uint8ClampedArray の コンストラクター23.2
%Uint16Array% Uint16Array Uint16Array の コンストラクター23.2
%Uint32Array% Uint32Array Uint32Array の コンストラクター23.2
%URIError% URIError URIError の コンストラクター20.5.5.6
%WeakMap% WeakMap WeakMap の コンストラクター24.3.1
%WeakRef% WeakRef WeakRefコンストラクター26.1.1
%WeakSet% WeakSet WeakSet の コンストラクター24.4.1
%WrapForValidIteratorPrototype% Iterator.from により返されるラップされた イテレーターオブジェクト のプロトタイプ(27.1.3.2.1.1

追加の項目は 表102 に記載されています。

6.2 ECMAScript 仕様タイプ

仕様タイプは、アルゴリズム内で ECMAScript 言語構成要素および ECMAScript 言語タイプ のセマンティクスを記述するために使用されるメタ値に対応します。仕様タイプには、Reference RecordListCompletion RecordProperty DescriptorEnvironment RecordAbstract Closure、および Data Block が含まれます。仕様タイプ値は、仕様上の成果物であり、ECMAScript 実装内の特定の実体に必ずしも対応しません。仕様タイプ値は、ECMAScript 式評価の中間結果を記述するために使用される場合がありますが、そのような値をオブジェクトのプロパティや ECMAScript 言語変数の値として格納することはできません。

6.2.1 Enum 仕様タイプ

Enum は仕様内部でのみ使用され、ECMAScript コードから直接観測できない値です。Enum は sans-serif 書体で表記されます。たとえば、Completion Record[[Type]] フィールドは normalreturnthrow などの値をとります。Enum にはその名前以外の特徴はなく、Enum の名前は他の Enum との区別のためだけに用いられ、その用途や意味については何も示しません。

6.2.2 List および Record 仕様タイプ

List 型は、new 式、関数呼び出し、その他のアルゴリズムで引数リスト(13.3.8 参照)の評価を説明するため、および値の単純な順序付きリストが必要な場合に使用されます。List 型の値は、個々の値を含むリスト要素の順序付きシーケンスです。これらのシーケンスは任意の長さにできます。リストの要素は、0 オリジンのインデックスを使ってランダムアクセスできます。記法上の便宜のため、配列風の構文で List 要素へアクセスすることができます。例えば、arguments[2] は、List arguments の 3 番目の要素を示します。

アルゴリズムが List の要素を順序を明示せずに反復する場合、その順序は List の要素順です。

この仕様内では、リテラル構文で新しい List 値を表現できます。例えば、« 1, 2 » は 2 つの要素を持つ List 値を表し、それぞれ特定の値で初期化されます。新しい空の List は « » で表現できます。

この仕様書では、「A, B, ... の list-concatenation」という表現(各引数は空の場合もある List)で、各引数の要素を(順に)連結した新しい List 値を意味します。

List of Strings に対して、「辞書式コードユニット順でソートする」とは、短い方の文字列の長さまで各コードユニットの数値値でソートし、すべて等しい場合は短い文字列を先に並べることを意味します。これは抽象操作 IsLessThan で説明されています。

Record 型は、この仕様のアルゴリズム内でデータの集約を記述するために使用されます。Record 型の値は 1 つ以上の名前付きフィールドからなります。各フィールドの値は ECMAScript 言語値 または仕様値です。フィールド名は常に二重括弧で囲まれます。例:[[Value]]

この仕様内ではオブジェクトリテラル風の構文で Record 値を表現できます。たとえば、{ [[Field1]]: 42, [[Field2]]: false, [[Field3]]: empty } は 3 つのフィールドを持つ Record 値を定義し、それぞれ特定の値で初期化されます。フィールド名の順序に意味はありません。明示的にリストされていないフィールドは存在しないものとみなされます。

仕様テキストやアルゴリズムでは、Record 値の特定のフィールドを参照するためにドット記法を使うことがあります。たとえば、前述の R というレコードに対して R.[[Field2]] は「R の [[Field2]] という名前のフィールド」を意味します。

よく使われる Record フィールドの組み合わせのスキーマには名前を付けることができ、その名前をリテラル Record 値の前に付与して、どの種類の集約が記述されているかを明示できます。例:PropertyDescriptor { [[Value]]: 42, [[Writable]]: false, [[Configurable]]: true }。

6.2.3 Set および Relation 仕様タイプ

Set 型は、メモリーモデル で使用する無順序要素の集合を説明するために使われます。これは同名の ECMAScript コレクション型とは異なります。区別のため、この仕様内では ECMAScript のコレクションのインスタンスは一貫して「Set オブジェクト」と呼ばれます。Set 型の値は単純な要素のコレクションで、同じ要素が複数回現れることはありません。要素は Set へ追加・削除できます。Set 同士は和集合・積集合・差集合の演算ができます。

Relation 型は、Set 上の制約を説明するために使われます。Relation 型の値は、その値領域の順序付きペアの Set です。たとえば、イベント上の Relation はイベントの順序付きペアの集合です。Relation R およびその値領域内の 2 つの値 ab に対し、a R b は順序付きペア (a, b) が R の要素であることを略記しています。Relation は、ある条件に対してそれを満たす最小の Relation(最小 Relation)である場合、その条件に関する最小の Relation です。

狭義半順序(strict partial order) とは、Relation 値 R が次を満たすことです。

  • すべての a, b, cR のドメイン内)について:

    • a R a は成り立たない(反射性なし)
    • a R b かつ b R c ならば a R c(推移性)
注1

上記2つの性質は、それぞれ反射性なし(irreflexivity)・推移性(transitivity)と呼ばれます。

狭義全順序(strict total order) とは、Relation 値 R が次を満たすことです。

  • すべての a, b, cR のドメイン内)について:

    • ab であるか、a R b か、b R a のいずれかである(全順序性)
    • a R a は成り立たない(反射性なし)
    • a R b かつ b R c ならば a R c(推移性)
注2

上記3つの性質は、それぞれ全順序性(totality)・反射性なし(irreflexivity)・推移性(transitivity)と呼ばれます。

6.2.4 完了レコード仕様タイプ

Completion Record 仕様タイプは、値のランタイム伝播や、breakcontinuereturnthrow など、制御の非局所的な移動を行う文の動作など、制御フローを説明するために用いられます。

Completion Record には 表7 で定義されているフィールドがあります。

表7: Completion Record のフィールド
フィールド名 意味
[[Type]] normal, break, continue, return, または throw 発生した完了の種類。
[[Value]] Completion Record 以外の任意の値 生成された値。
[[Target]] 文字列または empty 指定された制御移動のターゲットラベル。

Completion Record を指すために、以下のような略語が使われることがあります。

  • normal completion は、[[Type]] の値が normal である Completion Record を指します。
  • break completion は、[[Type]] の値が break である Completion Record を指します。
  • continue completion は、[[Type]] の値が continue である Completion Record を指します。
  • return completion は、[[Type]] の値が return である Completion Record を指します。
  • throw completion は、[[Type]] の値が throw である Completion Record を指します。
  • abrupt completion は、[[Type]] の値が normal 以外である Completion Record を指します。
  • normal completion containing ある型の値を含む normal completion とは、その型の値が [[Value]] フィールドにある normal completion を指します。

この仕様で定義される呼び出し可能オブジェクトは、normal completion または throw completion のみを返します。それ以外の Completion Record を返すことは編集上の誤りとみなされます。

実装依存 の呼び出し可能オブジェクトも normal completion または throw completion のいずれかを返さなければなりません。

6.2.4.1 NormalCompletion ( value )

抽象操作 NormalCompletion は、引数 valueCompletion Record 以外の任意の値)を受け取り、normal completion を返します。呼び出されたとき、次の手順を実行します。

  1. Completion Record { [[Type]]: normal, [[Value]]: value, [[Target]]: empty } を返す。

6.2.4.2 ThrowCompletion ( value )

抽象操作 ThrowCompletion は、引数 valueECMAScript 言語値)を受け取り、throw completion を返します。呼び出されたとき、次の手順を実行します。

  1. Completion Record { [[Type]]: throw, [[Value]]: value, [[Target]]: empty } を返す。

6.2.4.3 ReturnCompletion ( value )

抽象操作 ReturnCompletion は、引数 valueECMAScript 言語値)を受け取り、return completion を返します。呼び出されたとき、次の手順を実行します。

  1. Completion Record { [[Type]]: return, [[Value]]: value, [[Target]]: empty } を返す。

6.2.4.4 UpdateEmpty ( completionRecord, value )

抽象操作 UpdateEmpty は、引数 completionRecordCompletion Record)と valueCompletion Record 以外の任意の値)を受け取り、Completion Record を返します。呼び出されたとき、次の手順を実行します。

  1. アサート: completionRecordreturn completion または throw completion のいずれかである場合、completionRecord.[[Value]]empty であってはならない。
  2. もし completionRecord.[[Value]]empty でなければ、? completionRecord を返す。
  3. Completion Record { [[Type]]: completionRecord.[[Type]], [[Value]]: value, [[Target]]: completionRecord.[[Target]] } を返す。

6.2.5 参照レコード仕様タイプ

Reference Record 型は、deletetypeof、代入演算子、super キーワード、その他の言語機能の動作を説明するために使用されます。例えば、代入の左辺値は Reference Record を生成することが期待されます。

Reference Record は解決された名前または(まだ解決されていないかもしれない)プロパティバインディングであり、そのフィールドは 表8 で定義されています。

表8: Reference Record のフィールド
フィールド名 意味
[[Base]] ECMAScript 言語値Environment Record、または unresolvable バインディングを保持している値またはEnvironment Record[[Base]]unresolvable である場合、そのバインディングは解決できなかったことを示します。
[[ReferencedName]] ECMAScript 言語値 または Private Name バインディングの名前。[[Base]] の値が Environment Record の場合は常に文字列。それ以外の場合、ECMAScript 言語値 であり、ToPropertyKey が実行されるまで文字列やシンボル以外の可能性もあります。
[[Strict]] Boolean true の場合、その Reference Recordstrict mode code から生成されたことを示し、false の場合はそうでないことを示します。
[[ThisValue]] ECMAScript 言語値 または empty empty でない場合、その Reference Recordsuper キーワード を使って表現されたプロパティバインディングを表します。この場合、その [[Base]] 値は Environment Record にはなりません。その場合、[[ThisValue]] フィールドは Reference Record が作成された時点での this の値を保持します。これは Super Reference Record と呼ばれます。

この仕様で参照レコードを操作するために、以下の 抽象操作 が使用されます。

6.2.5.1 IsPropertyReference ( V )

抽象操作 IsPropertyReference は、引数 VReference Record)を受け取り、Boolean を返します。呼び出されたとき、次の手順を実行します。

  1. もし V.[[Base]]unresolvable なら、false を返す。
  2. もし V.[[Base]]Environment Record なら false を返し、それ以外なら true を返す。

6.2.5.2 IsUnresolvableReference ( V )

抽象操作 IsUnresolvableReference は、引数 VReference Record)を受け取り、Boolean を返します。呼び出されたとき、次の手順を実行します。

  1. もし V.[[Base]]unresolvable なら true を返し、それ以外なら false を返す。

6.2.5.3 IsSuperReference ( V )

抽象操作 IsSuperReference は、引数 VReference Record)を受け取り、Boolean を返します。呼び出されたとき、次の手順を実行します。

  1. もし V.[[ThisValue]]empty でなければ true を返し、それ以外なら false を返す。

6.2.5.4 IsPrivateReference ( V )

抽象操作 IsPrivateReference は、引数 VReference Record)を受け取り、Boolean を返します。呼び出されたとき、次の手順を実行します。

  1. もし V.[[ReferencedName]]Private Name であれば true を返し、それ以外なら false を返す。

6.2.5.5 GetValue ( V )

抽象操作 GetValue は、引数 VReference Record または ECMAScript 言語値)を受け取り、normal completion containingECMAScript 言語値 か、abrupt completion のいずれかを返します。呼び出されたとき、次の手順を実行します。

  1. もし VReference Record でなければ、V を返す。
  2. IsUnresolvableReference(V) が true なら、ReferenceError 例外をスローする。
  3. IsPropertyReference(V) が true なら、
    1. baseObj を ? ToObject(V.[[Base]]) とする。
    2. IsPrivateReference(V) が true なら、
      1. PrivateGet(baseObj, V.[[ReferencedName]]) を返す。
    3. V.[[ReferencedName]]property key でなければ、
      1. V.[[ReferencedName]] を ? ToPropertyKey(V.[[ReferencedName]]) とする。
    4. baseObj.[[Get]](V.[[ReferencedName]], GetThisValue(V)) を返す。
  4. それ以外の場合、
    1. baseV.[[Base]] とする。
    2. アサート: baseEnvironment Record である。
    3. base.GetBindingValue(V.[[ReferencedName]], V.[[Strict]]) を返す(9.1 参照)。

3.a で生成される可能性のあるオブジェクトは、上記の抽象操作および ordinary object[[Get]] 内部メソッドの外部からはアクセスできません。実装によっては実際にそのオブジェクトを生成しないこともあります。

6.2.5.6 PutValue ( V, W )

抽象操作 PutValue は、引数 VReference Record または ECMAScript 言語値)、WECMAScript 言語値)を受け取り、normal completion containingunused または abrupt completion を返します。呼び出されたとき、次の手順を実行します。

  1. もし VReference Record でなければ、ReferenceError 例外をスローする。
  2. IsUnresolvableReference(V) が true なら、
    1. もし V.[[Strict]]true なら、ReferenceError 例外をスローする。
    2. globalObjGetGlobalObject() とする。
    3. Set(globalObj, V.[[ReferencedName]], W, false) を実行する。
    4. unused を返す。
  3. IsPropertyReference(V) が true なら、
    1. baseObj を ? ToObject(V.[[Base]]) とする。
    2. IsPrivateReference(V) が true なら、
      1. PrivateSet(baseObj, V.[[ReferencedName]], W) を返す。
    3. V.[[ReferencedName]]property key でなければ、
      1. V.[[ReferencedName]] を ? ToPropertyKey(V.[[ReferencedName]]) とする。
    4. succeeded を ? baseObj.[[Set]](V.[[ReferencedName]], W, GetThisValue(V)) とする。
    5. もし succeededfalse かつ V.[[Strict]]true なら、TypeError 例外をスローする。
    6. unused を返す。
  4. それ以外の場合、
    1. baseV.[[Base]] とする。
    2. アサート: baseEnvironment Record である。
    3. base.SetMutableBinding(V.[[ReferencedName]], W, V.[[Strict]]) を返す(9.1 参照)。

3.a で生成される可能性のあるオブジェクトは、上記の抽象操作および ordinary object[[Set]] 内部メソッドの外部からはアクセスできません。実装によっては実際にそのオブジェクトを生成しないこともあります。

6.2.5.7 GetThisValue ( V )

抽象操作 GetThisValue は、引数 VReference Record)を受け取り、ECMAScript 言語値 を返します。呼び出されたとき、次の手順を実行します。

  1. アサート: IsPropertyReference(V) が true であること。
  2. IsSuperReference(V) が true なら V.[[ThisValue]] を返し、そうでなければ V.[[Base]] を返す。

6.2.5.8 InitializeReferencedBinding ( V, W )

抽象操作 InitializeReferencedBinding は、引数 VReference Record)、WECMAScript 言語値)を受け取り、normal completion containingunused または abrupt completion を返します。呼び出されたとき、次の手順を実行します。

  1. アサート: IsUnresolvableReference(V) が false であること。
  2. baseV.[[Base]] とする。
  3. アサート: baseEnvironment Record であること。
  4. base.InitializeBinding(V.[[ReferencedName]], W) を返す。

6.2.5.9 MakePrivateReference ( baseValue, privateIdentifier )

抽象操作 MakePrivateReference は、引数 baseValueECMAScript 言語値)、privateIdentifier(文字列)を受け取り、Reference Record を返します。呼び出されたとき、次の手順を実行します。

  1. privateEnv実行中の実行コンテキスト の PrivateEnvironment とする。
  2. アサート: privateEnvnull であってはならない。
  3. privateNameResolvePrivateIdentifier(privateEnv, privateIdentifier) とする。
  4. 次の Reference Record を返す: { [[Base]]: baseValue, [[ReferencedName]]: privateName, [[Strict]]: true, [[ThisValue]]: empty }.

6.2.6 プロパティ記述子仕様タイプ

Property Descriptor 型は、オブジェクトプロパティ属性の操作および具現化を説明するために用いられます。Property Descriptor は、Record であり、0個以上のフィールドを持ちます。各フィールド名は属性名であり、その値は 6.1.7.1 で規定された対応する属性値です。この仕様で Property Descriptor レコードのリテラル記述に付与されるスキーマ名は “PropertyDescriptor” です。

Property Descriptor の値は、特定のフィールドの有無によってデータ Property Descriptor またはアクセサ Property Descriptor に分類されることがあります。[[Value]] または [[Writable]] という名前のフィールドが存在するものはデータ Property Descriptor です。[[Get]] または [[Set]] という名前のフィールドが存在するものはアクセサ Property Descriptor です。どの Property Descriptor にも [[Enumerable]] および [[Configurable]] という名前のフィールドを持つことができます。Property Descriptor の値はデータ Property Descriptor とアクセサ Property Descriptor の両方であってはなりませんが、どちらでもない場合もあります(この場合は汎用 Property Descriptor です)。完全な Property Descriptor とは、アクセサ Property Descriptor またはデータ Property Descriptor であり、かつ 表3 に示されたすべての対応フィールドが定義されているものです。

この仕様で Property Descriptor の値を操作するために、以下の 抽象操作 が使用されます:

6.2.6.1 IsAccessorDescriptor ( Desc )

抽象操作 IsAccessorDescriptor は、引数 DescProperty Descriptor)を受け取り、Boolean を返します。呼び出されたとき、次の手順を実行します:

  1. もし Desc[[Get]] フィールドを持つなら、true を返す。
  2. もし Desc[[Set]] フィールドを持つなら、true を返す。
  3. false を返す。

6.2.6.2 IsDataDescriptor ( Desc )

抽象操作 IsDataDescriptor は、引数 DescProperty Descriptor)を受け取り、Boolean を返します。呼び出されたとき、次の手順を実行します:

  1. もし Desc[[Value]] フィールドを持つなら、true を返す。
  2. もし Desc[[Writable]] フィールドを持つなら、true を返す。
  3. false を返す。

6.2.6.3 IsGenericDescriptor ( Desc )

抽象操作 IsGenericDescriptor は、引数 DescProperty Descriptor)を受け取り、Boolean を返します。呼び出されたとき、次の手順を実行します:

  1. IsAccessorDescriptor(Desc) が true なら、false を返す。
  2. IsDataDescriptor(Desc) が true なら、false を返す。
  3. true を返す。

6.2.6.4 FromPropertyDescriptor ( Desc )

抽象操作 FromPropertyDescriptor は、引数 DescProperty Descriptor または undefined)を受け取り、オブジェクトまたは undefined を返します。呼び出されたとき、次の手順を実行します:

  1. もし Descundefined なら、undefined を返す。
  2. objOrdinaryObjectCreate(%Object.prototype%) とする。
  3. アサート: obj は自身のプロパティを持たない拡張可能な ordinary object である。
  4. もし Desc[[Value]] フィールドを持つなら:
    1. CreateDataPropertyOrThrow(obj, "value", Desc.[[Value]]) を実行する。
  5. もし Desc[[Writable]] フィールドを持つなら:
    1. CreateDataPropertyOrThrow(obj, "writable", Desc.[[Writable]]) を実行する。
  6. もし Desc[[Get]] フィールドを持つなら:
    1. CreateDataPropertyOrThrow(obj, "get", Desc.[[Get]]) を実行する。
  7. もし Desc[[Set]] フィールドを持つなら:
    1. CreateDataPropertyOrThrow(obj, "set", Desc.[[Set]]) を実行する。
  8. もし Desc[[Enumerable]] フィールドを持つなら:
    1. CreateDataPropertyOrThrow(obj, "enumerable", Desc.[[Enumerable]]) を実行する。
  9. もし Desc[[Configurable]] フィールドを持つなら:
    1. CreateDataPropertyOrThrow(obj, "configurable", Desc.[[Configurable]]) を実行する。
  10. obj を返す。

6.2.6.5 ToPropertyDescriptor ( Obj )

抽象操作 ToPropertyDescriptor は、引数 ObjECMAScript 言語値)を受け取り、normal completion containingProperty Descriptor または throw completion のいずれかを返します。呼び出されたとき、次の手順を実行します:

  1. もし Objオブジェクトでない なら、TypeError 例外をスローする。
  2. desc を新しい Property Descriptor(初期状態でフィールドなし)とする。
  3. hasEnumerable を ? HasProperty(Obj, "enumerable") とする。
  4. もし hasEnumerabletrue なら:
    1. enumerableToBoolean(? Get(Obj, "enumerable")) とする。
    2. desc.[[Enumerable]]enumerable を設定する。
  5. hasConfigurable を ? HasProperty(Obj, "configurable") とする。
  6. もし hasConfigurabletrue なら:
    1. configurableToBoolean(? Get(Obj, "configurable")) とする。
    2. desc.[[Configurable]]configurable を設定する。
  7. hasValue を ? HasProperty(Obj, "value") とする。
  8. もし hasValuetrue なら:
    1. value を ? Get(Obj, "value") とする。
    2. desc.[[Value]]value を設定する。
  9. hasWritable を ? HasProperty(Obj, "writable") とする。
  10. もし hasWritabletrue なら:
    1. writableToBoolean(? Get(Obj, "writable")) とする。
    2. desc.[[Writable]]writable を設定する。
  11. hasGet を ? HasProperty(Obj, "get") とする。
  12. もし hasGettrue なら:
    1. getter を ? Get(Obj, "get") とする。
    2. IsCallable(getter) が false かつ getterundefined でなければ、TypeError 例外をスローする。
    3. desc.[[Get]]getter を設定する。
  13. hasSet を ? HasProperty(Obj, "set") とする。
  14. もし hasSettrue なら:
    1. setter を ? Get(Obj, "set") とする。
    2. IsCallable(setter) が false かつ setterundefined でなければ、TypeError 例外をスローする。
    3. desc.[[Set]]setter を設定する。
  15. もし desc[[Get]] フィールドまたは [[Set]] フィールドを持つなら:
    1. もし desc[[Value]] フィールドまたは [[Writable]] フィールドを持つなら、TypeError 例外をスローする。
  16. desc を返す。

6.2.6.6 CompletePropertyDescriptor ( Desc )

抽象操作 CompletePropertyDescriptor は、引数 DescProperty Descriptor)を受け取り、unused を返します。呼び出されたとき、次の手順を実行します:

  1. likeRecord { [[Value]]: undefined, [[Writable]]: false, [[Get]]: undefined, [[Set]]: undefined, [[Enumerable]]: false, [[Configurable]]: false } とする。
  2. IsGenericDescriptor(Desc) が true または IsDataDescriptor(Desc) が true なら、
    1. もし Desc[[Value]] フィールドを持たないなら、Desc.[[Value]]like.[[Value]] を設定する。
    2. もし Desc[[Writable]] フィールドを持たないなら、Desc.[[Writable]]like.[[Writable]] を設定する。
  3. それ以外の場合:
    1. もし Desc[[Get]] フィールドを持たないなら、Desc.[[Get]]like.[[Get]] を設定する。
    2. もし Desc[[Set]] フィールドを持たないなら、Desc.[[Set]]like.[[Set]] を設定する。
  4. もし Desc[[Enumerable]] フィールドを持たないなら、Desc.[[Enumerable]]like.[[Enumerable]] を設定する。
  5. もし Desc[[Configurable]] フィールドを持たないなら、Desc.[[Configurable]]like.[[Configurable]] を設定する。
  6. unused を返す。

6.2.7 環境レコード仕様タイプ

Environment Record 型は、入れ子になった関数やブロックにおける名前解決の動作を説明するために使用されます。この型およびそれに対する操作は、9.1 で定義されています。

6.2.8 抽象クロージャ仕様タイプ

Abstract Closure 仕様タイプは、アルゴリズムのステップと値の集合をまとめて参照するために用いられます。Abstract Closure はメタ値であり、closure(arg1, arg2) のような関数適用スタイルで呼び出されます。抽象操作と同様に、呼び出し時には Abstract Closure で記述されたアルゴリズムステップが実行されます。

Abstract Closure を生成するアルゴリズムステップでは、「capture」に続いてエイリアスのリストが記載され、その値がキャプチャされます。Abstract Closure が生成されると、それぞれのエイリアスに対応する値をその時点でキャプチャします。Abstract Closure を呼び出したときに実行されるアルゴリズムを指定するステップでは、各キャプチャされた値はキャプチャ時に使われたエイリアスで参照されます。

Abstract Closure が Completion Record を返す場合、その Completion Recordnormal completion または throw completion でなければなりません。

Abstract Closure は他のアルゴリズムの一部としてインラインで作成され、次の例のように示されます。

  1. addend を 41 とする。
  2. closure を、パラメータ (x) を持ち addend をキャプチャし、呼び出されたときに次のステップを実行する新しい Abstract Closure とする:
    1. x + addend を返す。
  3. valclosure(1) とする。
  4. アサート: val は 42 である。

6.2.9 データブロック

Data Block 仕様タイプは、個別かつ可変なバイト(8ビット)値のシーケンスを記述するために用いられます。byte value とは、整数 であり、区間 [0, 255] に含まれるものです。Data Block の値は、各バイトが初期値 0 である固定バイト数で生成されます。

この仕様内では、記法上の便宜のため、Data Block 値の個々のバイトにアクセスするために配列風の構文を使うことができます。この記法は、Data Block 値を 0 基点の整数インデックス付きバイト列として提示します。例えば db が 5 バイトの Data Block 値であれば、db[2] は 3 番目のバイトにアクセスできます。

複数の agent から同時に参照できるメモリ上のデータブロックは、Shared Data Block と呼ばれます。Shared Data Block は(等価性判定のための)同一性が アドレスフリー です:任意のプロセスでマッピングされる仮想アドレスではなく、そのブロックが表すメモリ領域の集合に紐づきます。2つのデータブロックが等しいのは、それらが含む領域の集合が等しい場合のみであり、そうでなければ等しくなく、領域集合の共通部分は空です。最後に、Shared Data Block と Data Block は区別可能です。

Shared Data Block のセマンティクスは、Shared Data Block イベント により メモリーモデル で定義されます。下記の 抽象操作Shared Data Block イベント を導入し、評価セマンティクスと メモリーモデル のイベントセマンティクスのインターフェースとなります。イベントは 候補実行 を形成し、メモリーモデル がフィルタとして作用します。完全なセマンティクスについては メモリーモデル を参照してください。

Shared Data Block イベントRecord でモデル化されており、メモリーモデル で定義されています。

この仕様で Data Block 値を操作するために、以下の 抽象操作 が使用されます:

6.2.9.1 CreateByteDataBlock ( size )

抽象操作 CreateByteDataBlock は、引数 size(非負の 整数)を受け取り、normal completion containingData Block、または throw completion を返します。呼び出されたとき、次の手順を実行します:

  1. もし size > 253 - 1 なら、RangeError 例外をスローする。
  2. dbsize バイトからなる新しい Data Block 値とする。そのような Data Block を生成できない場合、RangeError 例外をスローする。
  3. db のすべてのバイトを 0 に設定する。
  4. db を返す。

6.2.9.2 CreateSharedByteDataBlock ( size )

抽象操作 CreateSharedByteDataBlock は、引数 size(非負の 整数) を受け取り、normal completion containingShared Data Block、または throw completion を返します。呼び出されたとき、次の手順を実行します:

  1. dbsize バイトからなる新しい Shared Data Block 値とする。そのような Shared Data Block を生成できない場合、RangeError 例外をスローする。
  2. execution周囲のエージェントAgent Record[[CandidateExecution]] フィールドとする。
  3. eventsRecordexecution.[[EventsRecords]] のうち、[[AgentSignifier]]AgentSignifier() である Agent Events Record とする。
  4. zero を « 0 » とする。
  5. db の各インデックス i について、
    1. WriteSharedMemory { [[Order]]: init, [[NoTear]]: true, [[Block]]: db, [[ByteIndex]]: i, [[ElementSize]]: 1, [[Payload]]: zero } を eventsRecord.[[EventList]] に追加する。
  6. db を返す。

6.2.9.3 CopyDataBlockBytes ( toBlock, toIndex, fromBlock, fromIndex, count )

抽象操作 CopyDataBlockBytes は、引数 toBlockData Block または Shared Data Block)、toIndex(非負の 整数)、fromBlockData Block または Shared Data Block)、fromIndex(非負の 整数)、count(非負の 整数)を受け取り、unused を返します。呼び出されたとき、次の手順を実行します:

  1. アサート: fromBlocktoBlock は異なる値であること。
  2. fromSizefromBlock のバイト数とする。
  3. アサート: fromIndex + countfromSize であること。
  4. toSizetoBlock のバイト数とする。
  5. アサート: toIndex + counttoSize であること。
  6. count > 0 の間、繰り返す:
    1. もし fromBlockShared Data Block なら、
      1. execution周囲のエージェントAgent Record[[CandidateExecution]] フィールドとする。
      2. eventsRecordexecution.[[EventsRecords]] のうち、[[AgentSignifier]]AgentSignifier() である Agent Events Record とする。
      3. bytes を、唯一の要素が非決定的に選択された byte value である List とする。
      4. 注:実装において bytes は基盤ハードウェア上の非アトミックな読み取り命令の結果です。非決定性は メモリーモデル の意味的要請であり、弱い一貫性を持つハードウェアの観測可能な挙動を記述するためのものです。
      5. readEventReadSharedMemory { [[Order]]: unordered, [[NoTear]]: true, [[Block]]: fromBlock, [[ByteIndex]]: fromIndex, [[ElementSize]]: 1 } とする。
      6. readEventeventsRecord.[[EventList]] に追加する。
      7. Chosen Value Record { [[Event]]: readEvent, [[ChosenValue]]: bytes } を execution.[[ChosenValues]] に追加する。
      8. もし toBlockShared Data Block なら、
        1. WriteSharedMemory { [[Order]]: unordered, [[NoTear]]: true, [[Block]]: toBlock, [[ByteIndex]]: toIndex, [[ElementSize]]: 1, [[Payload]]: bytes } を eventsRecord.[[EventList]] に追加する。
      9. それ以外の場合:
        1. toBlock[toIndex] に bytes[0] を設定する。
    2. それ以外の場合:
      1. アサート: toBlockShared Data Block でないこと。
      2. toBlock[toIndex] に fromBlock[fromIndex] を設定する。
    3. toIndextoIndex + 1 に設定する。
    4. fromIndexfromIndex + 1 に設定する。
    5. countcount - 1 に設定する。
  7. unused を返す。

6.2.10 PrivateElement 仕様タイプ

PrivateElement 型は、プライベートクラスフィールド・メソッド・アクセサの仕様で使用される Record です。Property Descriptor はプライベート要素には使用されませんが、プライベートフィールドは non-configurable、non-enumerable、writable な データプロパティ と同様に動作し、プライベートメソッドは non-configurable、non-enumerable、non-writable な データプロパティ と同様に、プライベートアクセサは non-configurable、non-enumerable な アクセサプロパティ と同様に動作します。

PrivateElement 型の値は、Record 値であり、そのフィールドは 表9 で定義されています。これらの値は PrivateElement と呼ばれます。

表9: PrivateElement のフィールド
フィールド名 そのフィールドが存在する [[Kind]] フィールドの値 意味
[[Key]] 全て Private Name フィールド、メソッド、またはアクセサの名前。
[[Kind]] 全て field, method, または accessor 要素の種類。
[[Value]] field および method ECMAScript 言語値 フィールドの値。
[[Get]] accessor 関数オブジェクト または undefined プライベートアクセサの getter。
[[Set]] accessor 関数オブジェクト または undefined プライベートアクセサの setter。

6.2.11 ClassFieldDefinition レコード仕様タイプ

ClassFieldDefinition 型は、クラスフィールドの仕様で使用される Record です。

ClassFieldDefinition 型の値は Record 値であり、そのフィールドは 表10 で定義されています。これらの値は ClassFieldDefinition Record と呼ばれます。

表10: ClassFieldDefinition Record のフィールド
フィールド名 意味
[[Name]] Private Name、文字列、または シンボル フィールドの名前。
[[Initializer]] ECMAScript 関数オブジェクト または empty フィールドの初期化子(あれば)。

6.2.12 プライベート名

Private Name 仕様タイプは、プライベートクラス要素(フィールド、メソッド、アクセサ)のキーを表すグローバルに一意な値(たとえ他の Private Name と区別がつかなくても、必ず異なる値)を記述するために用いられます。各 Private Name には、文字列値である不変の [[Description]] が関連付けられています。Private Name は、PrivateFieldAdd または PrivateMethodOrAccessorAdd を使って任意の ECMAScript オブジェクトにインストールでき、その後 PrivateGet および PrivateSet を使って読み書きできます。

6.2.13 ClassStaticBlockDefinition レコード仕様タイプ

ClassStaticBlockDefinition Record は、クラスの static 初期化ブロックの実行可能なコードをカプセル化するために用いられる Record 値です。

ClassStaticBlockDefinition Record は、表11 に示すフィールドを持ちます。

表11: ClassStaticBlockDefinition Record のフィールド
フィールド名 意味
[[BodyFunction]] ECMAScript 関数オブジェクト クラスの static 初期化時に呼び出される 関数オブジェクト

7 抽象操作

これらの操作は ECMAScript 言語の一部ではなく、ECMAScript 言語のセマンティクス仕様を補助するためだけにここで定義されています。他にも、より専門的な抽象操作が本仕様全体で定義されています。

7.1 型変換

ECMAScript 言語は必要に応じて暗黙的に自動型変換を行います。特定の構文のセマンティクスを明確にするために、一連の変換抽象操作を定義することが有用です。これらの変換抽象操作は多態的であり、任意のECMAScript 言語型の値を受け入れることができます。ただし、これらの操作で他の仕様タイプは使用されません。

BigInt 型は ECMAScript 言語において自動変換されることはありません。開発者は他の型から変換したい場合は明示的に BigInt を呼び出す必要があります。

7.1.1 ToPrimitive ( input [ , preferredType ] )

抽象操作 ToPrimitive は、引数 inputECMAScript 言語値)と、オプションの引数 preferredTypestring または number)を受け取り、normal completion containingECMAScript 言語値 または throw completion を返します。この操作は input 引数を非Object 型に変換します。オブジェクトが複数のプリミティブ型に変換可能な場合、オプションのヒント preferredType を使ってその型を優先することがあります。呼び出されたとき、次の手順を実行します:

  1. もし inputオブジェクトなら、
    1. exoticToPrim を ? GetMethod(input, %Symbol.toPrimitive%) とする。
    2. もし exoticToPrimundefined でなければ、
      1. もし preferredType が与えられていなければ、
        1. hint"default" とする。
      2. そうでなく、preferredTypestring なら、
        1. hint"string" とする。
      3. それ以外の場合、
        1. アサート: preferredTypenumber である。
        2. hint"number" とする。
      4. result を ? Call(exoticToPrim, input, « hint » ) とする。
      5. もし resultオブジェクトでなければ result を返す。
      6. TypeError 例外をスローする。
    3. もし preferredType が与えられていなければ、preferredTypenumber とする。
    4. OrdinaryToPrimitive(input, preferredType) を返す。
  2. input を返す。

ToPrimitive がヒントなしで呼ばれた場合、一般的にはヒントが number であるかのように振る舞います。ただし、オブジェクトが %Symbol.toPrimitive% メソッドを定義することでこの振る舞いを上書きできます。本仕様で定義されているオブジェクトの中でこのデフォルトの ToPrimitive の振る舞いを上書きするのは Date(21.4.4.45)と Symbol オブジェクト(20.4.3.5)のみです。Date はヒントが未指定の場合、string であるかのように振る舞います。

7.1.1.1 OrdinaryToPrimitive ( O, hint )

抽象操作 OrdinaryToPrimitive は、引数 O(オブジェクト)と hintstring または number)を受け取り、normal completion containingECMAScript 言語値 または throw completion を返します。呼び出されたとき、次の手順を実行します:

  1. もし hintstring なら、
    1. methodNames を « "toString", "valueOf" » とする。
  2. それ以外の場合、
    1. methodNames を « "valueOf", "toString" » とする。
  3. methodNames の各要素 name について、
    1. method を ? Get(O, name) とする。
    2. もし IsCallable(method) が true なら、
      1. result を ? Call(method, O) とする。
      2. もし resultオブジェクトでなければ result を返す。
  4. TypeError 例外をスローする。

7.1.2 ToBoolean ( argument )

抽象操作 ToBoolean は、引数 argumentECMAScript 言語値)を受け取り、Boolean を返します。argument を Boolean 型の値に変換します。呼び出されたとき、次の手順を実行します:

  1. もし argumentBoolean なら、argument を返す。
  2. もし argumentundefinednull+0𝔽-0𝔽NaN0、または空文字列のいずれかなら、false を返す。
  3. 注:このステップは B.3.6.1 で置き換えられます。
  4. true を返す。

7.1.3 ToNumeric ( value )

抽象操作 ToNumeric は、引数 valueECMAScript 言語値)を受け取り、normal completion containing な Number または BigInt、あるいは throw completion を返します。value を Number または BigInt に変換して返します。呼び出されたとき、次の手順を実行します:

  1. primValue を ? ToPrimitive(value, number) とする。
  2. もし primValueBigInt なら、primValue を返す。
  3. ToNumber(primValue) を返す。

7.1.4 ToNumber ( argument )

抽象操作 ToNumber は、引数 argumentECMAScript 言語値)を受け取り、normal completion containing な Number、または throw completion を返します。argument を Number 型の値に変換します。呼び出されたとき、次の手順を実行します:

  1. もし argumentNumber なら、argument を返す。
  2. もし argument が Symbol または BigInt なら、TypeError 例外をスローする。
  3. もし argumentundefined なら、NaN を返す。
  4. もし argumentnull または false なら、+0𝔽 を返す。
  5. もし argumenttrue なら、1𝔽 を返す。
  6. もし argument文字列なら、StringToNumber(argument) を返す。
  7. アサート: argumentオブジェクトである。
  8. primValue を ? ToPrimitive(argument, number) とする。
  9. アサート: primValueオブジェクトでないこと。
  10. ToNumber(primValue) を返す。

7.1.4.1 文字列型に適用される ToNumber

抽象操作 StringToNumber は、次の文法を用いて文字列値を数値値へ変換する方法を規定します。

構文

StringNumericLiteral ::: StrWhiteSpaceopt StrWhiteSpaceopt StrNumericLiteral StrWhiteSpaceopt StrWhiteSpace ::: StrWhiteSpaceChar StrWhiteSpaceopt StrWhiteSpaceChar ::: WhiteSpace LineTerminator StrNumericLiteral ::: StrDecimalLiteral NonDecimalIntegerLiteral[~Sep] StrDecimalLiteral ::: StrUnsignedDecimalLiteral + StrUnsignedDecimalLiteral - StrUnsignedDecimalLiteral StrUnsignedDecimalLiteral ::: Infinity DecimalDigits[~Sep] . DecimalDigits[~Sep]opt ExponentPart[~Sep]opt . DecimalDigits[~Sep] ExponentPart[~Sep]opt DecimalDigits[~Sep] ExponentPart[~Sep]opt

上記で明示的に定義されていない全ての文法記号は、数値リテラルの字句文法(12.9.3)で使われている定義を持ちます。

StringNumericLiteral の構文と NumericLiteral の構文にはいくつかの違いがあることに注意してください:

7.1.4.1.1 StringToNumber ( str )

抽象操作 StringToNumber は、引数 str(文字列)を受け取り、数値を返します。呼び出されたとき、次の手順を実行します:

  1. literalParseText(str, StringNumericLiteral) とする。
  2. もし literalList のエラーであれば、NaN を返す。
  3. literalStringNumericValue を返す。

7.1.4.1.2 実行時セマンティクス: StringNumericValue

構文指示操作 StringNumericValue は引数を取らず、数値を返します。

StringNumericLiteral から数値値への変換は、NumericValueNumericLiteral の値、12.9.3 参照)の決定と全体的に似ていますが、詳細にはいくつか差異があります。

以下の生成規則に対し分割的に定義されます:

StringNumericLiteral ::: StrWhiteSpaceopt
  1. +0𝔽 を返す。
StringNumericLiteral ::: StrWhiteSpaceopt StrNumericLiteral StrWhiteSpaceopt
  1. StrNumericLiteralStringNumericValue を返す。
StrNumericLiteral ::: NonDecimalIntegerLiteral
  1. NonDecimalIntegerLiteral の MV を 𝔽 で返す。
StrDecimalLiteral ::: - StrUnsignedDecimalLiteral
  1. aStrUnsignedDecimalLiteralStringNumericValue とする。
  2. もし a+0𝔽 なら -0𝔽 を返す。
  3. -a を返す。
StrUnsignedDecimalLiteral ::: Infinity
  1. +∞𝔽 を返す。
StrUnsignedDecimalLiteral ::: DecimalDigits . DecimalDigitsopt ExponentPartopt
  1. 最初の DecimalDigits の MV を a とする。
  2. 2番目の DecimalDigits が存在する場合、
    1. 2番目の DecimalDigits の MV を b とする。
    2. 2番目の DecimalDigits の符号位置数を n とする。
  3. それ以外の場合、
    1. b を 0 とする。
    2. n を 0 とする。
  4. ExponentPart が存在する場合、eExponentPart の MV とし、それ以外の場合 e を 0 とする。
  5. RoundMVResult((a + (b × 10-n)) × 10e) を返す。
StrUnsignedDecimalLiteral ::: . DecimalDigits ExponentPartopt
  1. DecimalDigits の MV を b とする。
  2. ExponentPart が存在する場合、eExponentPart の MV とし、それ以外の場合 e を 0 とする。
  3. DecimalDigits の符号位置数を n とする。
  4. RoundMVResult(b × 10e - n) を返す。
StrUnsignedDecimalLiteral ::: DecimalDigits ExponentPartopt
  1. DecimalDigits の MV を a とする。
  2. ExponentPart が存在する場合、eExponentPart の MV とし、それ以外の場合 e を 0 とする。
  3. RoundMVResult(a × 10e) を返す。

7.1.4.1.3 RoundMVResult ( n )

抽象操作 RoundMVResult は、引数 n数学値)を受け取り、数値を返します。これは n実装依存 の方法で数値に変換します。この抽象操作においては、ある桁が有効桁であるとは、その桁が 0 でないか、左か右のいずれかに 0 でない桁が存在する場合を意味します。また、「ある 数学値 の表現が表す 数学値」とは、「数学値 の10進表現」の逆であるとみなします。呼び出されたとき、次の手順を実行します:

  1. n の10進表現が20桁以下の有効桁を持つ場合、𝔽(n) を返す。
  2. option1 を、n の10進表現の21桁目以降の有効桁をすべて0に置き換えた結果が表す 数学値 とする。
  3. option2 を、n の10進表現の21桁目以降の有効桁をすべて0に置き換えた後、21桁目を切り上げ(必要に応じて繰り上げ)た結果が表す 数学値 とする。
  4. chosen を、実装依存option1 または option2 のいずれかとする。
  5. 𝔽(chosen) を返す。

7.1.5 ToIntegerOrInfinity ( argument )

抽象操作 ToIntegerOrInfinity は、引数 argumentECMAScript 言語値)を受け取り、normal completion containing整数、+∞、または -∞、あるいは throw completion を返します。これは argument を、その Number 値の小数部分を切り捨てた整数、または Number 値が無限大の場合 +∞ あるいは -∞ に変換します。呼び出されたとき、次の手順を実行します:

  1. number を ? ToNumber(argument) とする。
  2. もし numberNaN+0𝔽-0𝔽 のいずれかなら、0 を返す。
  3. もし number+∞𝔽 なら、+∞ を返す。
  4. もし number-∞𝔽 なら、-∞ を返す。
  5. truncate((number)) を返す。
𝔽(ToIntegerOrInfinity(x)) は、任意の x に対して -0𝔽 を返すことはありません。小数部分の切り捨ては x数学値 に変換した後に行われます。

7.1.6 ToInt32 ( argument )

抽象操作 ToInt32 は、引数 argumentECMAScript 言語値)を受け取り、normal completion containing整数 Number、または throw completion を返します。これは argument整数 Number のうち、区間 𝔽(-231) から 𝔽(231 - 1) のいずれかに変換します。呼び出されたとき、次の手順を実行します:

  1. number を ? ToNumber(argument) とする。
  2. もし number有限 でない、または number+0𝔽 もしくは -0𝔽 であるなら、+0𝔽 を返す。
  3. inttruncate((number)) とする。
  4. int32bitint modulo 232 とする。
  5. もし int32bit ≥ 231 なら、𝔽(int32bit - 232) を返し、そうでなければ 𝔽(int32bit) を返す。

上記 ToInt32 の定義により:

  • ToInt32 抽象操作は冪等性を持ちます:その結果に再度適用しても値は変わりません。
  • ToInt32(ToUint32(x)) は、任意の x に対し ToInt32(x) と同じ値を返します。(この性質を保つために、+∞𝔽-∞𝔽+0𝔽 に変換されます。)
  • ToInt32 は -0𝔽+0𝔽 にマッピングします。

7.1.7 ToUint32 ( argument )

抽象操作 ToUint32 は、引数 argumentECMAScript 言語値)を受け取り、normal completion containing整数 Number、または throw completion を返します。これは argument整数 Number のうち、区間 +0𝔽 から 𝔽(232 - 1) のいずれかに変換します。呼び出されたとき、次の手順を実行します:

  1. number を ? ToNumber(argument) とする。
  2. もし number有限 でない、または number+0𝔽 もしくは -0𝔽 であるなら、+0𝔽 を返す。
  3. inttruncate((number)) とする。
  4. int32bitint modulo 232 とする。
  5. 𝔽(int32bit) を返す。

上記 ToUint32 の定義により:

  • 5 は ToUint32 と ToInt32 の唯一の違いです。
  • ToUint32 抽象操作は冪等性を持ちます:その結果に再度適用しても値は変わりません。
  • ToUint32(ToInt32(x)) は、任意の x に対し ToUint32(x) と同じ値を返します。(この性質を保つために、+∞𝔽-∞𝔽+0𝔽 に変換されます。)
  • ToUint32 は -0𝔽+0𝔽 にマッピングします。

7.1.8 ToInt16 ( argument )

抽象操作 ToInt16 は、引数 argumentECMAScript 言語値)を受け取り、normal completion containing整数 Number、または throw completion を返します。これは argument整数 Number のうち、区間 𝔽(-215) から 𝔽(215 - 1) のいずれかに変換します。呼び出されたとき、次の手順を実行します:

  1. number を ? ToNumber(argument) とする。
  2. もし number有限 でない、または number+0𝔽 もしくは -0𝔽 であるなら、+0𝔽 を返す。
  3. inttruncate((number)) とする。
  4. int16bitint modulo 216 とする。
  5. もし int16bit ≥ 215 なら、𝔽(int16bit - 216) を返し、そうでなければ 𝔽(int16bit) を返す。

7.1.9 ToUint16 ( argument )

抽象操作 ToUint16 は、引数 argumentECMAScript 言語値)を受け取り、normal completion containing整数 Number、または throw completion を返します。これは argument整数 Number のうち、区間 +0𝔽 から 𝔽(216 - 1) のいずれかに変換します。呼び出されたとき、次の手順を実行します:

  1. number を ? ToNumber(argument) とする。
  2. もし number有限 でない、または number+0𝔽 もしくは -0𝔽 であるなら、+0𝔽 を返す。
  3. inttruncate((number)) とする。
  4. int16bitint modulo 216 とする。
  5. 𝔽(int16bit) を返す。

上記 ToUint16 の定義により:

  • 4 で 216 を使うことが ToUint32 と ToUint16 の唯一の違いです。
  • ToUint16 は -0𝔽+0𝔽 にマッピングします。

7.1.10 ToInt8 ( argument )

抽象操作 ToInt8 は、引数 argumentECMAScript 言語値)を受け取り、normal completion containing整数 Number、または throw completion を返します。これは argument整数 Number のうち、区間 -128𝔽 から 127𝔽 のいずれかに変換します。呼び出されたとき、次の手順を実行します:

  1. number を ? ToNumber(argument) とする。
  2. もし number有限 でない、または number+0𝔽 もしくは -0𝔽 であるなら、+0𝔽 を返す。
  3. inttruncate((number)) とする。
  4. int8bitint modulo 28 とする。
  5. もし int8bit ≥ 27 なら、𝔽(int8bit - 28) を返し、そうでなければ 𝔽(int8bit) を返す。

7.1.11 ToUint8 ( argument )

抽象操作 ToUint8 は、引数 argumentECMAScript 言語値)を受け取り、normal completion containing整数 Number、または throw completion を返します。これは argument整数 Number のうち、区間 +0𝔽 から 255𝔽 のいずれかに変換します。呼び出されたとき、次の手順を実行します:

  1. number を ? ToNumber(argument) とする。
  2. もし number有限 でない、または number+0𝔽 もしくは -0𝔽 であるなら、+0𝔽 を返す。
  3. inttruncate((number)) とする。
  4. int8bitint modulo 28 とする。
  5. 𝔽(int8bit) を返す。

7.1.12 ToUint8Clamp ( argument )

抽象操作 ToUint8Clamp は、引数 argumentECMAScript 言語値)を受け取り、normal completion containing整数 Number、または throw completion を返します。これは argument整数 Number のうち、区間 +0𝔽 から 255𝔽 に丸めてクランプします。呼び出されたとき、次の手順を実行します:

  1. number を ? ToNumber(argument) とする。
  2. もし numberNaN なら、+0𝔽 を返す。
  3. mvnumber の拡張数学値 とする。
  4. clampedclamping mv を 0 から 255 の間でクランプした結果とする。
  5. ffloor(clamped) とする。
  6. もし clamped < f + 0.5 なら、𝔽(f) を返す。
  7. もし clamped > f + 0.5 なら、𝔽(f + 1) を返す。
  8. もし f が偶数なら、𝔽(f) を返し、そうでなければ 𝔽(f + 1) を返す。

他のほとんどの ECMAScript 整数 変換操作とは異なり、ToUint8Clamp は非整数値を切り捨てるのではなく丸めます。また、Math.round の「四捨五入」タイブレークとは異なり、「最近接偶数への丸め(round half to even)」を使用します。

7.1.13 ToBigInt ( argument )

抽象操作 ToBigInt は、引数 argumentECMAScript 言語値)を受け取り、normal completion containing な BigInt、または throw completion を返します。これは argument を BigInt 値に変換し、Number からの暗黙的な変換が必要な場合は例外を投げます。呼び出されたとき、次の手順を実行します:

  1. prim を ? ToPrimitive(argument, number) とする。
  2. prim に対応する値を 表12 から返す。
表12: BigInt 変換
引数の型 結果
Undefined TypeError 例外を投げる。
Null TypeError 例外を投げる。
Boolean primtrue なら 1nprimfalse なら 0n を返す。
BigInt prim を返す。
Number TypeError 例外を投げる。
String
  1. nStringToBigInt(prim) とする。
  2. もし nundefined なら、SyntaxError 例外を投げる。
  3. n を返す。
Symbol TypeError 例外を投げる。

7.1.14 StringToBigInt ( str )

抽象操作 StringToBigInt は、引数 str(文字列)を受け取り、BigInt または undefined を返します。呼び出されたとき、次の手順を実行します:

  1. literalParseText(str, StringIntegerLiteral) とする。
  2. もし literalList のエラーであれば、undefined を返す。
  3. mvliteral の MV とする。
  4. アサート: mv整数 である。
  5. (mv) を返す。

7.1.14.1 StringIntegerLiteral 文法

StringToBigInt は次の文法を使用します。

構文

StringIntegerLiteral ::: StrWhiteSpaceopt StrWhiteSpaceopt StrIntegerLiteral StrWhiteSpaceopt StrIntegerLiteral ::: SignedInteger[~Sep] NonDecimalIntegerLiteral[~Sep]

7.1.14.2 実行時セマンティクス: MV

7.1.15 ToBigInt64 ( argument )

抽象操作 ToBigInt64 は、引数 argumentECMAScript 言語値)を受け取り、normal completion containing な BigInt、または throw completion を返します。これは argument区間 (-263) から (263 - 1) の 264 個の BigInt 値のいずれかに変換します。呼び出されたとき、次の手順を実行します:

  1. n を ? ToBigInt(argument) とする。
  2. int64bit(n) modulo 264 とする。
  3. もし int64bit ≥ 263 なら、(int64bit - 264) を返し、そうでなければ (int64bit) を返す。

7.1.16 ToBigUint64 ( argument )

抽象操作 ToBigUint64 は、引数 argumentECMAScript 言語値)を受け取り、normal completion containing な BigInt、または throw completion を返します。これは argument区間 0 から (264 - 1) の 264 個の BigInt 値のいずれかに変換します。呼び出されたとき、次の手順を実行します:

  1. n を ? ToBigInt(argument) とする。
  2. int64bit(n) modulo 264 とする。
  3. (int64bit) を返す。

7.1.17 ToString ( argument )

抽象操作 ToString は、引数 argumentECMAScript 言語値)を受け取り、normal completion containing な文字列、または throw completion を返します。これは argument を String 型の値に変換します。呼び出されたとき、次の手順を実行します:

  1. もし argument文字列なら、argument を返す。
  2. もし argumentシンボルなら、TypeError 例外を投げる。
  3. もし argumentundefined なら、"undefined" を返す。
  4. もし argumentnull なら、"null" を返す。
  5. もし argumenttrue なら、"true" を返す。
  6. もし argumentfalse なら、"false" を返す。
  7. もし argument数値なら、Number::toString(argument, 10) を返す。
  8. もし argumentBigIntなら、BigInt::toString(argument, 10) を返す。
  9. アサート: argumentオブジェクトである。
  10. primValue を ? ToPrimitive(argument, string) とする。
  11. アサート: primValueオブジェクトでないこと。
  12. ToString(primValue) を返す。

7.1.18 ToObject ( argument )

抽象操作 ToObject は、引数 argumentECMAScript 言語値)を受け取り、normal completion containing なオブジェクト、または throw completion を返します。これは argument表13 に従って Object 型の値に変換します:

表13: ToObject 変換
引数の型 結果
Undefined TypeError 例外を投げる。
Null TypeError 例外を投げる。
Boolean [[BooleanData]] 内部スロットが argument に設定された新しい Boolean オブジェクトを返す。Boolean オブジェクトの説明は 20.3 を参照。
Number [[NumberData]] 内部スロットが argument に設定された新しい Number オブジェクトを返す。Number オブジェクトの説明は 21.1 を参照。
String [[StringData]] 内部スロットが argument に設定された新しい String オブジェクトを返す。String オブジェクトの説明は 22.1 を参照。
Symbol [[SymbolData]] 内部スロットが argument に設定された新しい Symbol オブジェクトを返す。Symbol オブジェクトの説明は 20.4 を参照。
BigInt [[BigIntData]] 内部スロットが argument に設定された新しい BigInt オブジェクトを返す。BigInt オブジェクトの説明は 21.2 を参照。
Object argument を返す。

7.1.19 ToPropertyKey ( argument )

抽象操作 ToPropertyKey は、引数 argumentECMAScript 言語値)を受け取り、normal completion containingプロパティキー、または throw completion を返します。これは argumentプロパティキー として使用できる値に変換します。呼び出されたとき、次の手順を実行します:

  1. key を ? ToPrimitive(argument, string) とする。
  2. もし keyシンボルなら、
    1. key を返す。
  3. ToString(key) を返す。

7.1.20 ToLength ( argument )

抽象操作 ToLength は、引数 argumentECMAScript 言語値)を受け取り、normal completion containing な非負の 整数 Number、または throw completion を返します。これは argument整数 Number へクランプし切り捨てて、配列様オブジェクト の長さとして使える値にします。呼び出されたとき、次の手順を実行します:

  1. len を ? ToIntegerOrInfinity(argument) とする。
  2. もし len ≤ 0 なら、+0𝔽 を返す。
  3. 𝔽(min(len, 253 - 1)) を返す。

7.1.21 CanonicalNumericIndexString ( argument )

抽象操作 CanonicalNumericIndexString は、引数 argument(文字列)を受け取り、数値または undefined を返します。argument"-0" または、ある数値 n について ToString(n) に完全一致する場合は、その数値 n を返します。それ以外は undefined を返します。呼び出されたとき、次の手順を実行します:

  1. もし argument"-0" なら、-0𝔽 を返す。
  2. n を ! ToNumber(argument) とする。
  3. もし ! ToString(n) が argument と一致するなら、n を返す。
  4. undefined を返す。

canonical numeric string とは、CanonicalNumericIndexString 抽象操作が undefined を返さない任意の文字列です。

7.1.22 ToIndex ( value )

抽象操作 ToIndex は、引数 valueECMAScript 言語値)を受け取り、normal completion containing な非負の 整数、または throw completion を返します。これは value整数 に変換し、それが非負かつ 整数インデックス に対応していればその整数を返します。そうでなければ例外を投げます。呼び出されたとき、次の手順を実行します:

  1. integer を ? ToIntegerOrInfinity(value) とする。
  2. もし integer区間 0 から 253 - 1 に含まれていなければ、RangeError 例外を投げる。
  3. integer を返す。

7.2 テストおよび比較操作

7.2.1 RequireObjectCoercible ( argument )

抽象操作 RequireObjectCoercible は、引数 argumentECMAScript 言語値)を受け取り、normal completion containingECMAScript 言語値 または throw completion を返します。argumentToObject でオブジェクトに変換できない値の場合はエラーを投げます。表14で定義されています:

表14: RequireObjectCoercible の結果
引数の型 結果
Undefined TypeError 例外を投げる。
Null TypeError 例外を投げる。
Boolean argument を返す。
Number argument を返す。
String argument を返す。
Symbol argument を返す。
BigInt argument を返す。
Object argument を返す。

7.2.2 IsArray ( argument )

抽象操作 IsArray は、引数 argumentECMAScript 言語値)を受け取り、normal completion containing な Boolean、または throw completion を返します。呼び出されたとき、次の手順を実行します:

  1. もし argumentオブジェクトでない場合、false を返す。
  2. もし argument配列エキゾチックオブジェクト なら true を返す。
  3. もし argumentProxy エキゾチックオブジェクト なら、
    1. ValidateNonRevokedProxy(argument) を行う。
    2. proxyTargetargument.[[ProxyTarget]] とする。
    3. IsArray(proxyTarget) を返す。
  4. false を返す。

7.2.3 IsCallable ( argument )

抽象操作 IsCallable は、引数 argumentECMAScript 言語値)を受け取り、Boolean を返します。argument[[Call]] 内部メソッドを持つ呼び出し可能な関数かを判定します。呼び出されたとき、次の手順を実行します:

  1. もし argumentオブジェクトでない場合、false を返す。
  2. もし argument[[Call]] 内部メソッドを持てば true を返す。
  3. false を返す。

7.2.4 IsConstructor ( argument )

抽象操作 IsConstructor は、引数 argumentECMAScript 言語値)を受け取り、Boolean を返します。argument関数オブジェクト[[Construct]] 内部メソッドを持つかどうかを判定します。呼び出されたとき、次の手順を実行します:

  1. もし argumentオブジェクトでない場合、false を返す。
  2. もし argument[[Construct]] 内部メソッドを持てば true を返す。
  3. false を返す。

7.2.5 IsExtensible ( O )

抽象操作 IsExtensible は、引数 O(オブジェクト)を受け取り、normal completion containing な Boolean、または throw completion を返します。これは O にプロパティを追加できるかを判定するために使われます。呼び出されたとき、次の手順を実行します:

  1. O.[[IsExtensible]]() を返す。

7.2.6 IsRegExp ( argument )

抽象操作 IsRegExp は、引数 argumentECMAScript 言語値)を受け取り、normal completion containing な Boolean、または throw completion を返します。呼び出されたとき、次の手順を実行します:

  1. もし argumentオブジェクトでない場合、false を返す。
  2. matcher を ? Get(argument, %Symbol.match%) とする。
  3. もし matcherundefined でなければ、ToBoolean(matcher) を返す。
  4. もし argument[[RegExpMatcher]] 内部スロットを持てば、true を返す。
  5. false を返す。

7.2.7 静的セマンティクス: IsStringWellFormedUnicode ( string )

抽象操作 IsStringWellFormedUnicode は、引数 string(文字列)を受け取り、Boolean を返します。string6.1.4 で説明される UTF-16 エンコード符号点列として解釈し、well formed な UTF-16 シーケンスかどうかを判定します。呼び出されたとき、次の手順を実行します:

  1. lenstring の長さとする。
  2. k を 0 とする。
  3. 繰り返し、k < len の間:
    1. cpCodePointAt(string, k) とする。
    2. もし cp.[[IsUnpairedSurrogate]]true なら、false を返す。
    3. kk + cp.[[CodeUnitCount]] に設定する。
  4. true を返す。

7.2.8 SameType ( x, y )

抽象操作 SameType は、引数 xECMAScript 言語値)と yECMAScript 言語値)を受け取り、Boolean を返します。2つの引数が同じ型かどうかを判定します。呼び出されたとき、次の手順を実行します:

  1. もし xundefined かつ yundefined なら true を返す。
  2. もし xnull かつ ynull なら true を返す。
  3. もし xBoolean かつ yBoolean なら true を返す。
  4. もし xNumber かつ yNumber なら true を返す。
  5. もし xBigInt かつ yBigInt なら true を返す。
  6. もし xシンボル かつ yシンボル なら true を返す。
  7. もし x文字列 かつ y文字列 なら true を返す。
  8. もし xオブジェクト かつ yオブジェクト なら true を返す。
  9. false を返す。

7.2.9 SameValue ( x, y )

抽象操作 SameValue は、引数 xECMAScript 言語値)および yECMAScript 言語値)を受け取り、Boolean を返します。これは2つの引数が同じ値かどうかを判定します。呼び出されたとき、次の手順を実行します:

  1. もし SameType(x, y) が false なら、false を返す。
  2. もし xNumber なら、
    1. Number::sameValue(x, y) を返す。
  3. SameValueNonNumber(x, y) を返す。

このアルゴリズムは IsStrictlyEqual アルゴリズムと異なり、全ての NaN を等価とみなし、+0𝔽-0𝔽 を区別します。

7.2.10 SameValueZero ( x, y )

抽象操作 SameValueZero は、引数 xECMAScript 言語値)および yECMAScript 言語値)を受け取り、Boolean を返します。これは2つの引数が同じ値かどうか(+0𝔽-0𝔽 の違いを無視)を判定します。呼び出されたとき、次の手順を実行します:

  1. もし SameType(x, y) が false なら、false を返す。
  2. もし xNumber なら、
    1. Number::sameValueZero(x, y) を返す。
  3. SameValueNonNumber(x, y) を返す。

SameValueZero は SameValue と異なり、+0𝔽-0𝔽 を等価とみなします。

7.2.11 SameValueNonNumber ( x, y )

抽象操作 SameValueNonNumber は、引数 xECMAScript 言語値 ただし Number ではない)および yECMAScript 言語値 ただし Number ではない)を受け取り、Boolean を返します。呼び出されたとき、次の手順を実行します:

  1. アサート: SameType(x, y) は true である。
  2. もし xundefined または null なら、true を返す。
  3. もし xBigInt なら、
    1. BigInt::equal(x, y) を返す。
  4. もし x文字列 なら、
    1. もし xy の長さが等しく、かつ同じ位置のコード単位が全て一致するなら true を返し、そうでなければ false を返す。
  5. もし xBoolean なら、
    1. もし xy がともに true かともに false なら true を返し、そうでなければ false を返す。
  6. 注:その他の ECMAScript 言語値 は同一性(identity)で比較されます。
  7. もし xy であれば true、そうでなければ false を返す。
注1
本アルゴリズムでは説明の都合上、実際には分離しなくてもよい場合でも一部のケースを分離して取り扱っています。
注2
xy である」の詳細は 5.2.7 を参照してください。

7.2.12 IsLessThan ( x, y, LeftFirst )

抽象操作 IsLessThan は、引数 xECMAScript 言語値)、yECMAScript 言語値)、LeftFirst(Boolean)を受け取り、normal completion containing な Boolean または undefined、あるいは throw completion を返します。これは x < y の比較の意味を提供し、truefalse、または(少なくとも一方が NaN の場合)undefined を返します。LeftFirst フラグは x および y への副作用の順序を制御するために使われます。これは ECMAScript が式の評価を左から右に行うことを規定しているため、必要です。LeftFirsttrue なら xy より左の式、false なら逆に y の方を先に評価します。呼び出されたとき、次の手順を実行します:

  1. もし LeftFirsttrue なら、
    1. px を ? ToPrimitive(x, number) とする。
    2. py を ? ToPrimitive(y, number) とする。
  2. それ以外の場合、
    1. 注:評価順を逆にすることで左から右の評価を保証する必要がある。
    2. py を ? ToPrimitive(y, number) とする。
    3. px を ? ToPrimitive(x, number) とする。
  3. もし px文字列 かつ py文字列なら、
    1. lxpx の長さとする。
    2. lypy の長さとする。
    3. 0 ≤ i < min(lx, ly) である 整数 i について昇順で、
      1. cxpx のインデックス i のコード単位の数値とする。
      2. cypy のインデックス i のコード単位の数値とする。
      3. もし cx < cy なら true を返す。
      4. もし cx > cy なら false を返す。
    4. もし lx < ly なら true を返し、そうでなければ false を返す。
  4. それ以外の場合、
    1. もし pxBigInt かつ py文字列 なら、
      1. nyStringToBigInt(py) とする。
      2. もし nyundefined なら undefined を返す。
      3. BigInt::lessThan(px, ny) を返す。
    2. もし px文字列 かつ pyBigInt なら、
      1. nxStringToBigInt(px) とする。
      2. もし nxundefined なら undefined を返す。
      3. BigInt::lessThan(nx, py) を返す。
    3. 注:pxpy はプリミティブ値なので評価順は重要でない。
    4. nx を ? ToNumeric(px) とする。
    5. ny を ? ToNumeric(py) とする。
    6. もし SameType(nx, ny) が true なら、
      1. もし nxNumber なら、
        1. Number::lessThan(nx, ny) を返す。
      2. それ以外の場合、
        1. アサート: nxBigIntである。
        2. BigInt::lessThan(nx, ny) を返す。
    7. アサート: nxBigIntで、nyNumber、または nxNumbernyBigInt
    8. もし nx または nyNaN なら undefined を返す。
    9. もし nx-∞𝔽 または ny+∞𝔽 なら true を返す。
    10. もし nx+∞𝔽 または ny-∞𝔽 なら false を返す。
    11. もし (nx) < (ny) なら true を返し、そうでなければ false を返す。
注1

ステップ 3 は、加算演算子 + を扱うアルゴリズム(13.15.3)のステップ 1.c と異なり、論理積(and)を使います(そちらは論理和 or)。

注2

文字列の比較は UTF-16 コード単位列に対する単純な辞書順比較を用います。Unicode 仕様で定義されるより複雑で意味論的な文字・文字列の等価性や照合順序は考慮されません。そのため、Unicode 標準で正規等価な値であっても正規化形式が異なる場合は等価判定されないことがあります。また、コード単位による辞書順は、サロゲートペアを含む文字列ではコードポイントによる順序付けとは異なります。

7.2.13 IsLooselyEqual ( x, y )

抽象操作 IsLooselyEqual は、引数 xECMAScript 言語値)および yECMAScript 言語値)を受け取り、normal completion containing な Boolean、または throw completion を返します。これは == 演算子の意味を与えます。呼び出されたとき、次の手順を実行します:

  1. もし SameType(x, y) が true なら、
    1. IsStrictlyEqual(x, y) を返す。
  2. もし xnull かつ yundefined なら true を返す。
  3. もし xundefined かつ ynull なら true を返す。
  4. 注:このステップは B.3.6.2 で置き換えられます。
  5. もし xNumber かつ y文字列なら、! IsLooselyEqual(x, ! ToNumber(y)) を返す。
  6. もし x文字列 かつ yNumberなら、! IsLooselyEqual(! ToNumber(x), y) を返す。
  7. もし xBigInt かつ y文字列なら、
    1. nStringToBigInt(y) とする。
    2. もし nundefined なら false を返す。
    3. IsLooselyEqual(x, n) を返す。
  8. もし x文字列 かつ yBigIntなら、! IsLooselyEqual(y, x) を返す。
  9. もし xBoolean なら、! IsLooselyEqual(! ToNumber(x), y) を返す。
  10. もし yBoolean なら、! IsLooselyEqual(x, ! ToNumber(y)) を返す。
  11. もし x が 文字列、数値、BigInt、またはシンボルのいずれかで yオブジェクトなら、! IsLooselyEqual(x, ? ToPrimitive(y)) を返す。
  12. もし xオブジェクト かつ y が 文字列、数値、BigInt、またはシンボルのいずれかなら、! IsLooselyEqual(? ToPrimitive(x), y) を返す。
  13. もし xBigInt かつ yNumber、または xNumber かつ yBigInt なら、
    1. もし x有限 でないか、または y有限 でなければ false を返す。
    2. もし (x) = (y) なら true を返し、そうでなければ false を返す。
  14. false を返す。

7.2.14 IsStrictlyEqual ( x, y )

抽象操作 IsStrictlyEqual は、引数 xECMAScript 言語値)および yECMAScript 言語値)を受け取り、Boolean を返します。これは === 演算子の意味を与えます。呼び出されたとき、次の手順を実行します:

  1. もし SameType(x, y) が false なら、false を返す。
  2. もし xNumber なら、
    1. Number::equal(x, y) を返す。
  3. SameValueNonNumber(x, y) を返す。

このアルゴリズムは SameValue アルゴリズムと、符号付き0やNaNの扱いが異なります。

7.3 オブジェクトに対する操作

7.3.1 MakeBasicObject ( internalSlotsList )

抽象操作 MakeBasicObject は、引数 internalSlotsList内部スロット名のリスト)を受け取り、オブジェクトを返します。これはアルゴリズム的に生成される全ての ECMAScript オブジェクト、すなわち 通常オブジェクトエキゾチックオブジェクト を含む全オブジェクトの元となります。全てのオブジェクト生成で共通となる手順を切り出し、オブジェクト生成を一元化します。呼び出されたとき、次の手順を実行します:

  1. internalSlotsListリスト連結internalSlotsList と « [[PrivateElements]] » の連結に設定する。
  2. internalSlotsList の各名前に対応する内部スロットを持つ新しいオブジェクト obj を生成する。
  3. 注:オブジェクトの内部メソッドと内部スロット で説明されているように、これらの内部スロットの初期値は特に指定がない限り undefined である。
  4. obj.[[PrivateElements]] を新しい空の リスト に設定する。
  5. obj の本質的な内部メソッドを、通常オブジェクト10.1 で規定されるデフォルトの定義に設定する。
  6. アサート: 呼び出し元が obj[[GetPrototypeOf]] および [[SetPrototypeOf]] の両方の本質的な内部メソッドを上書きしないなら、internalSlotsList[[Prototype]] を含む。
  7. アサート: 呼び出し元が obj[[SetPrototypeOf]], [[IsExtensible]], [[PreventExtensions]] の全ての本質的な内部メソッドを上書きしないなら、internalSlotsList[[Extensible]] を含む。
  8. もし internalSlotsList[[Extensible]] を含むなら、obj.[[Extensible]]true に設定する。
  9. obj を返す。

本仕様内では、エキゾチックオブジェクト抽象操作(例えば ArrayCreateBoundFunctionCreate)内でまず MakeBasicObject を呼び出して基本となるオブジェクトを取得し、その後そのオブジェクトの内部メソッドの一部または全部を上書きすることで作成されます。エキゾチックオブジェクト作成のカプセル化のため、これらの操作以外で本質的内部メソッドが変更されることはありません。

7.3.2 Get ( O, P )

抽象操作 Get は、引数 O(オブジェクト)と Pプロパティキー)を受け取り、normal completion containingECMAScript 言語値 または throw completion を返します。これはオブジェクトの特定のプロパティ値を取得するために使われます。呼び出されたとき、次の手順を実行します:

  1. O.[[Get]](P, O) を返す。

7.3.3 GetV ( V, P )

抽象操作 GetV は、引数 VECMAScript 言語値)と Pプロパティキー)を受け取り、normal completion containingECMAScript 言語値 または throw completion を返します。これは ECMAScript 言語値 の特定のプロパティ値を取得するために使われます。値がオブジェクトでない場合、型に応じたラッパーオブジェクトを使ってプロパティ検索が行われます。呼び出されたとき、次の手順を実行します:

  1. O を ? ToObject(V) とする。
  2. O.[[Get]](P, V) を返す。

7.3.4 Set ( O, P, V, Throw )

抽象操作 Set は、引数 O(オブジェクト)、Pプロパティキー)、VECMAScript 言語値)、Throw(Boolean)を受け取り、normal completion containingunused、または throw completion を返します。これはオブジェクトの特定のプロパティ値を設定するために使われます。V はプロパティに設定する新しい値です。呼び出されたとき、次の手順を実行します:

  1. success を ? O.[[Set]](P, V, O) とする。
  2. もし successfalse かつ Throwtrue なら、TypeError 例外を投げる。
  3. unused を返す。

7.3.5 CreateDataProperty ( O, P, V )

抽象操作 CreateDataProperty は、引数 O(オブジェクト)、Pプロパティキー)、VECMAScript 言語値)を受け取り、normal completion containing な Boolean または throw completion を返します。これはオブジェクトに新しい自身のプロパティを生成するために使用されます。呼び出されたとき、次の手順を実行します:

  1. newDesc を PropertyDescriptor { [[Value]]: V, [[Writable]]: true, [[Enumerable]]: true, [[Configurable]]: true } とする。
  2. O.[[DefineOwnProperty]](P, newDesc) を返す。

この抽象操作は、ECMAScript 言語の代入演算子によって作成されるプロパティと同じデフォルト属性でプロパティを生成します。通常、このプロパティは既存しません。もし既に存在し、それが設定可能でない場合や O が拡張不可能な場合、[[DefineOwnProperty]]false を返します。

7.3.6 CreateDataPropertyOrThrow ( O, P, V )

抽象操作 CreateDataPropertyOrThrow は、引数 O(オブジェクト)、Pプロパティキー)、VECMAScript 言語値)を受け取り、normal completion containingunused または throw completion を返します。これはオブジェクトに新しい自身のプロパティを生成するために使用されます。要求されたプロパティ更新ができない場合は TypeError 例外を投げます。呼び出されたとき、次の手順を実行します:

  1. success を ? CreateDataProperty(O, P, V) とする。
  2. もし successfalse なら、TypeError 例外を投げる。
  3. unused を返す。

この抽象操作は、ECMAScript 言語の代入演算子によって作成されるプロパティと同じデフォルト属性でプロパティを生成します。通常、このプロパティは既存しません。もし既に存在し、それが設定可能でない場合や O が拡張不可能な場合、[[DefineOwnProperty]]false を返し、この操作は TypeError 例外を投げます。

7.3.7 CreateNonEnumerableDataPropertyOrThrow ( O, P, V )

抽象操作 CreateNonEnumerableDataPropertyOrThrow は、引数 O(オブジェクト)、Pプロパティキー)、VECMAScript 言語値)を受け取り、unused を返します。これは 通常オブジェクトに新しい列挙不可の自身のプロパティを生成するために使用されます。呼び出されたとき、次の手順を実行します:

  1. アサート: O は通常の拡張可能なオブジェクトで、非設定可能なプロパティを持たない。
  2. newDesc を PropertyDescriptor { [[Value]]: V, [[Writable]]: true, [[Enumerable]]: false, [[Configurable]]: true } とする。
  3. DefinePropertyOrThrow(O, P, newDesc) を実行する。
  4. unused を返す。

この抽象操作は、ECMAScript 言語の代入演算子で生成されるプロパティと同じデフォルト属性でプロパティを作成しますが、列挙不可となる点が異なります。通常、このプロパティは既存しません。もし既に存在する場合、DefinePropertyOrThrow は常に正常に完了することが保証されています。

7.3.8 DefinePropertyOrThrow ( O, P, desc )

抽象操作 DefinePropertyOrThrow は、引数 O(オブジェクト)、Pプロパティキー)、descプロパティディスクリプタ)を受け取り、normal completion containingunused または throw completion を返します。これは、要求されたプロパティ更新ができない場合 TypeError 例外を投げる形で、オブジェクトの [[DefineOwnProperty]] 内部メソッドを呼び出すために使用されます。呼び出されたとき、次の手順を実行します:

  1. success を ? O.[[DefineOwnProperty]](P, desc) とする。
  2. もし successfalse なら、TypeError 例外を投げる。
  3. unused を返す。

7.3.9 DeletePropertyOrThrow ( O, P )

抽象操作 DeletePropertyOrThrow は、引数 O(オブジェクト)と Pプロパティキー)を受け取り、normal completion containingunused または throw completion を返します。これはオブジェクトの特定の自身のプロパティを削除するために使われます。そのプロパティが設定可能でない場合は例外を投げます。呼び出されたとき、次の手順を実行します:

  1. success を ? O.[[Delete]](P) とする。
  2. もし successfalse なら、TypeError 例外を投げる。
  3. unused を返す。

7.3.10 GetMethod ( V, P )

抽象操作 GetMethod は、引数 VECMAScript 言語値)と Pプロパティキー)を受け取り、normal completion containing関数オブジェクト または undefined、もしくは throw completion を返します。これはプロパティ値が関数であることが期待される場合に、ECMAScript 言語値 の特定プロパティ値を取得するために使用されます。呼び出されたとき、次の手順を実行します:

  1. func を ? GetV(V, P) とする。
  2. もし funcundefined または null なら、undefined を返す。
  3. もし IsCallable(func) が false なら、TypeError 例外を投げる。
  4. func を返す。

7.3.11 HasProperty ( O, P )

抽象操作 HasProperty は、引数 O(オブジェクト)と Pプロパティキー)を受け取り、normal completion containing な Boolean または throw completion を返します。これはオブジェクトが指定された プロパティキー を持つかどうかを判定するために使われます。プロパティは自身または継承されたものでかまいません。呼び出されたとき、次の手順を実行します:

  1. O.[[HasProperty]](P) を返す。

7.3.12 HasOwnProperty ( O, P )

抽象操作 HasOwnProperty は、引数 O(オブジェクト)と Pプロパティキー)を受け取り、normal completion containing な Boolean または throw completion を返します。これはオブジェクトが指定された プロパティキー を自身のプロパティとして持つかどうかを判定するために使われます。呼び出されたとき、次の手順を実行します:

  1. desc を ? O.[[GetOwnProperty]](P) とする。
  2. もし descundefined なら false を返す。
  3. true を返す。

7.3.13 Call ( F, V [ , argumentsList ] )

抽象操作 Call は、引数 FECMAScript 言語値)、VECMAScript 言語値)、および省略可能な argumentsListECMAScript 言語値のリスト)を受け取り、normal completion containingECMAScript 言語値 または throw completion を返します。これは [[Call]] 内部メソッドを呼び出すために使われます。F関数オブジェクトV はその [[Call]]this 値、argumentsList は内部メソッドの該当引数に渡される値です。argumentsList が省略された場合は新しい空の リストが使用されます。呼び出されたとき、次の手順を実行します:

  1. もし argumentsList が省略された場合、argumentsList を新しい空の リスト に設定する。
  2. もし IsCallable(F) が false なら、TypeError 例外を投げる。
  3. F.[[Call]](V, argumentsList) を返す。

7.3.14 Construct ( F [ , argumentsList [ , newTarget ] ] )

抽象操作 Construct は、引数 Fコンストラクタ)、および省略可能な argumentsListリストECMAScript 言語値のリスト)、newTargetコンストラクタ)を受け取り、normal completion containing なオブジェクト、または throw completion を返します。これは 関数オブジェクト[[Construct]] 内部メソッドを呼び出すために使われます。argumentsList および newTarget は内部メソッドの対応する引数として渡されます。argumentsList が省略された場合は新しい空の リスト が値として使われます。newTarget が省略された場合は F が値として使われます。呼び出されたとき、次の手順を実行します:

  1. もし newTarget が省略された場合、newTargetF に設定する。
  2. もし argumentsList が省略された場合、argumentsList を新しい空の リスト に設定する。
  3. F.[[Construct]](argumentsList, newTarget) を返す。

newTarget が省略された場合、この操作は new F(...argumentsList) と同等です。

7.3.15 SetIntegrityLevel ( O, level )

抽象操作 SetIntegrityLevel は、引数 O(オブジェクト)、levelsealed または frozen)を受け取り、normal completion containing な Boolean または throw completion を返します。これはオブジェクトの自身のプロパティの集合を固定するために使われます。呼び出されたとき、次の手順を実行します:

  1. status を ? O.[[PreventExtensions]]() とする。
  2. もし statusfalse なら、false を返す。
  3. keys を ? O.[[OwnPropertyKeys]]() とする。
  4. もし levelsealed なら、
    1. keys の各要素 k について、
      1. DefinePropertyOrThrow(O, k, PropertyDescriptor { [[Configurable]]: false }) を実行する。
  5. それ以外の場合、
    1. アサート: levelfrozen である。
    2. keys の各要素 k について、
      1. currentDesc を ? O.[[GetOwnProperty]](k) とする。
      2. もし currentDescundefined でなければ、
        1. もし IsAccessorDescriptor(currentDesc) が true なら、
          1. desc を PropertyDescriptor { [[Configurable]]: false } とする。
        2. それ以外の場合、
          1. desc を PropertyDescriptor { [[Configurable]]: false, [[Writable]]: false } とする。
        3. DefinePropertyOrThrow(O, k, desc) を実行する。
  6. true を返す。

7.3.16 TestIntegrityLevel ( O, level )

抽象操作 TestIntegrityLevel は、引数 O(オブジェクト)、levelsealed または frozen)を受け取り、normal completion containing な Boolean または throw completion を返します。これはオブジェクトの自身のプロパティの集合が固定されているかどうかを判定するために使われます。呼び出されたとき、次の手順を実行します:

  1. extensible を ? IsExtensible(O) とする。
  2. もし extensibletrue なら、false を返す。
  3. 注:オブジェクトが拡張可能である場合、そのプロパティは検査されません。
  4. keys を ? O.[[OwnPropertyKeys]]() とする。
  5. keys の各要素 k について、
    1. currentDesc を ? O.[[GetOwnProperty]](k) とする。
    2. もし currentDescundefined でなければ、
      1. もし currentDesc.[[Configurable]]true なら、false を返す。
      2. もし levelfrozen かつ IsDataDescriptor(currentDesc) が true なら、
        1. もし currentDesc.[[Writable]]true なら、false を返す。
  6. true を返す。

7.3.17 CreateArrayFromList ( elements )

抽象操作 CreateArrayFromList は、引数 elementsリストECMAScript 言語値のリスト)を受け取り、配列を返します。これは elements で与えられた要素を持つ配列を生成するために使われます。呼び出されたとき、次の手順を実行します:

  1. array を ! ArrayCreate(0) とする。
  2. n を 0 とする。
  3. elements の各要素 e について、
    1. CreateDataPropertyOrThrow(array, ! ToString(𝔽(n)), e) を実行する。
    2. nn + 1 に設定する。
  4. array を返す。

7.3.18 LengthOfArrayLike ( obj )

抽象操作 LengthOfArrayLike は、引数 obj(オブジェクト)を受け取り、normal completion containing な非負の 整数 または throw completion を返します。これは配列様オブジェクトの "length" プロパティの値を返します。呼び出されたとき、次の手順を実行します:

  1. (? ToLength(? Get(obj, "length"))) を返す。

配列様オブジェクト とは、この操作が normal completion を返す任意のオブジェクトです。

注1
通常、配列様オブジェクトは 整数インデックス名のプロパティも持ちますが、この定義の要件ではありません。
注2
配列や String オブジェクトは配列様オブジェクトの例です。

7.3.19 CreateListFromArrayLike ( obj [ , validElementTypes ] )

抽象操作 CreateListFromArrayLike は、引数 objECMAScript 言語値)と省略可能な validElementTypesall または property-key)を受け取り、normal completion containingリストECMAScript 言語値のリスト、または throw completion を返します。これは obj のインデックス付きプロパティによって与えられる要素で構成される リスト値を生成するために使われます。validElementTypes は要素として許容される値の型を示します。呼び出されたとき、次の手順を実行します:

  1. もし validElementTypes が指定されていなければ、validElementTypesall に設定する。
  2. もし objオブジェクトでないなら、TypeError 例外を投げる。
  3. len を ? LengthOfArrayLike(obj) とする。
  4. list を新しい空の リスト とする。
  5. index を 0 とする。
  6. index < len の間、繰り返し:
    1. indexName を ! ToString(𝔽(index)) とする。
    2. next を ? Get(obj, indexName) とする。
    3. もし validElementTypesproperty-key かつ nextプロパティキー でないなら、TypeError 例外を投げる。
    4. nextlist に追加する。
    5. indexindex + 1 に設定する。
  7. list を返す。

7.3.20 Invoke ( V, P [ , argumentsList ] )

抽象操作 Invoke は、引数 VECMAScript 言語値)、Pプロパティキー)、および省略可能な argumentsListリストECMAScript 言語値のリスト)を受け取り、normal completion containingECMAScript 言語値 または throw completion を返します。これは ECMAScript 言語値 のメソッドプロパティを呼び出すために使われます。V はプロパティ検索元かつ呼び出し時の this 値として機能します。argumentsList はメソッドに渡す引数のリストです。argumentsList が省略された場合は新しい空の リスト が値として使われます。呼び出されたとき、次の手順を実行します:

  1. もし argumentsList が指定されていなければ、argumentsList を新しい空の リスト に設定する。
  2. func を ? GetV(V, P) とする。
  3. Call(func, V, argumentsList) を返す。

7.3.21 OrdinaryHasInstance ( C, O )

抽象操作 OrdinaryHasInstance は、引数 CECMAScript 言語値)、OECMAScript 言語値)を受け取り、normal completion containing な Boolean または throw completion を返します。これは OC によって提供されるインスタンスオブジェクト継承パスから継承しているかどうかを判定するデフォルトアルゴリズムです。呼び出されたとき、次の手順を実行します:

  1. もし IsCallable(C) が false なら、false を返す。
  2. もし C[[BoundTargetFunction]] 内部スロットを持つなら、
    1. BCC.[[BoundTargetFunction]] とする。
    2. InstanceofOperator(O, BC) を返す。
  3. もし Oオブジェクトでないなら、false を返す。
  4. P を ? Get(C, "prototype") とする。
  5. もし Pオブジェクトでないなら、TypeError 例外を投げる。
  6. 繰り返し:
    1. O を ? O.[[GetPrototypeOf]]() に設定する。
    2. もし Onull なら、false を返す。
    3. もし SameValue(P, O) が true なら、true を返す。

7.3.22 SpeciesConstructor ( O, defaultConstructor )

抽象操作 SpeciesConstructor は、引数 O(オブジェクト)、defaultConstructorコンストラクタ)を受け取り、normal completion containingコンストラクタ、または throw completion を返します。これは O から派生した新しいオブジェクトを作成するために使用されるべき コンストラクタ を取得するために使われます。defaultConstructor は、O から コンストラクタ %Symbol.species% プロパティが見つからなかった場合に使用される コンストラクタ です。呼び出されたとき、次の手順を実行します:

  1. C を ? Get(O, "constructor") とする。
  2. もし Cundefined なら、defaultConstructor を返す。
  3. もし Cオブジェクトでないなら、TypeError 例外を投げる。
  4. S を ? Get(C, %Symbol.species%) とする。
  5. もし Sundefined または null なら、defaultConstructor を返す。
  6. もし IsConstructor(S) が true なら、S を返す。
  7. TypeError 例外を投げる。

7.3.23 EnumerableOwnProperties ( O, kind )

抽象操作 EnumerableOwnProperties は、引数 O(オブジェクト)、kindkeyvalue、または key+value)を受け取り、normal completion containingリストECMAScript 言語値のリスト、または throw completion を返します。呼び出されたとき、次の手順を実行します:

  1. ownKeys を ? O.[[OwnPropertyKeys]]() とする。
  2. results を新しい空の リスト とする。
  3. ownKeys の各要素 key について:
    1. もし key文字列なら、
      1. desc を ? O.[[GetOwnProperty]](key) とする。
      2. もし descundefined でなく、かつ desc.[[Enumerable]]true なら、
        1. もし kindkey なら、
          1. keyresults に追加する。
        2. それ以外の場合、
          1. value を ? Get(O, key) とする。
          2. もし kindvalue なら、
            1. valueresults に追加する。
          3. それ以外の場合、
            1. アサート: kindkey+value である。
            2. entryCreateArrayFromListkey, value » ) とする。
            3. entryresults に追加する。
  4. results を返す。

7.3.24 GetFunctionRealm ( obj )

抽象操作 GetFunctionRealm は、引数 obj関数オブジェクト)を受け取り、normal completion containingRealm Record または throw completion を返します。呼び出されたとき、次の手順を実行します:

  1. もし obj[[Realm]] 内部スロットを持つなら、
    1. obj.[[Realm]] を返す。
  2. もし obj束縛関数エキゾチックオブジェクトなら、
    1. boundTargetFunctionobj.[[BoundTargetFunction]] とする。
    2. GetFunctionRealm(boundTargetFunction) を返す。
  3. もし objProxy エキゾチックオブジェクトなら、
    1. ValidateNonRevokedProxy(obj) を実行する。
    2. proxyTargetobj.[[ProxyTarget]] とする。
    3. アサート: proxyTarget関数オブジェクト である。
    4. GetFunctionRealm(proxyTarget) を返す。
  4. 現在の Realm Record を返す。

ステップ 4 に到達するのは、obj[[Realm]] 内部スロットを持たない非標準の エキゾチックオブジェクト の場合のみです。

7.3.25 CopyDataProperties ( target, source, excludedItems )

抽象操作 CopyDataProperties は、引数 target(オブジェクト)、sourceECMAScript 言語値)、excludedItemsプロパティキーのリスト)を受け取り、normal completion containingunused または throw completion を返します。呼び出されたとき、次の手順を実行します:

  1. もし sourceundefined または null なら、unused を返す。
  2. from を ! ToObject(source) とする。
  3. keys を ? from.[[OwnPropertyKeys]]() とする。
  4. keys の各要素 nextKey について、
    1. excludedfalse に設定する。
    2. excludedItems の各要素 e について、
      1. もし SameValue(e, nextKey) が true なら、
        1. excludedtrue に設定する。
    3. もし excludedfalse なら、
      1. desc を ? from.[[GetOwnProperty]](nextKey) とする。
      2. もし descundefined でなく、かつ desc.[[Enumerable]]true なら、
        1. propValue を ? Get(from, nextKey) とする。
        2. CreateDataPropertyOrThrow(target, nextKey, propValue) を実行する。
  5. unused を返す。

ここで渡される target は常に新しく作成されたオブジェクトであり、エラーが投げられた場合に直接アクセスすることはできません。

7.3.26 PrivateElementFind ( O, P )

抽象操作 PrivateElementFind は、引数 O(オブジェクト)、PPrivate Name)を受け取り、PrivateElement または empty を返します。呼び出されたとき、次の手順を実行します:

  1. もし O.[[PrivateElements]]PrivateElement pe を含み、かつ pe.[[Key]]P であるなら、
    1. pe を返す。
  2. empty を返す。

7.3.27 PrivateFieldAdd ( O, P, value )

抽象操作 PrivateFieldAdd は、引数 O(オブジェクト)、PPrivate Name)、valueECMAScript 言語値)を受け取り、normal completion containingunused または throw completion を返します。呼び出されたとき、次の手順を実行します:

  1. もし ホスト が Webブラウザなら、
    1. HostEnsureCanAddPrivateElement(O) を実行する。
  2. entryPrivateElementFind(O, P) とする。
  3. もし entryempty でないなら、TypeError 例外を投げる。
  4. PrivateElement { [[Key]]: P, [[Kind]]: field, [[Value]]: value } を O.[[PrivateElements]] に追加する。
  5. unused を返す。

7.3.28 PrivateMethodOrAccessorAdd ( O, method )

抽象操作 PrivateMethodOrAccessorAdd は、引数 O(オブジェクト)、methodPrivateElement)を受け取り、normal completion containingunused または throw completion を返します。呼び出されたとき、次の手順を実行します:

  1. アサート: method.[[Kind]]method または accessor である。
  2. もし ホスト が Webブラウザなら、
    1. HostEnsureCanAddPrivateElement(O) を実行する。
  3. entryPrivateElementFind(O, method.[[Key]]) とする。
  4. もし entryempty でないなら、TypeError 例外を投げる。
  5. methodO.[[PrivateElements]] に追加する。
  6. unused を返す。

プライベートメソッドおよびアクセサの値はインスタンス間で共有されます。この操作はメソッドやアクセサのコピーを新たに作成しません。

7.3.29 HostEnsureCanAddPrivateElement ( O )

ホスト定義 抽象操作 HostEnsureCanAddPrivateElement は、引数 O(オブジェクト)を受け取り、normal completion containingunused または throw completion を返します。これは ホスト環境 が特定の ホスト定義 エキゾチックオブジェクト へのプライベート要素の追加を防ぐことができるようにします。

HostEnsureCanAddPrivateElement の実装は以下の要件を満たさなければなりません:

HostEnsureCanAddPrivateElement のデフォルト実装は NormalCompletion(unused) を返す。

この抽象操作は ECMAScript の ホスト が Webブラウザの場合のみ呼び出されます。

7.3.30 PrivateGet ( O, P )

抽象操作 PrivateGet は、引数 O(オブジェクト)、PPrivate Name)を受け取り、normal completion containingECMAScript 言語値 または throw completion を返します。呼び出されたとき、次の手順を実行します:

  1. entryPrivateElementFind(O, P) とする。
  2. もし entryempty なら、TypeError 例外を投げる。
  3. もし entry.[[Kind]]field または method なら、
    1. entry.[[Value]] を返す。
  4. アサート: entry.[[Kind]]accessor である。
  5. もし entry.[[Get]]undefined なら、TypeError 例外を投げる。
  6. getterentry.[[Get]] とする。
  7. Call(getter, O) を返す。

7.3.31 PrivateSet ( O, P, value )

抽象操作 PrivateSet は、引数 O(オブジェクト)、PPrivate Name)、valueECMAScript 言語値)を受け取り、normal completion containingunused または throw completion を返します。呼び出されたとき、次の手順を実行します:

  1. entryPrivateElementFind(O, P) とする。
  2. もし entryempty なら、TypeError 例外を投げる。
  3. もし entry.[[Kind]]field なら、
    1. entry.[[Value]]value に設定する。
  4. それ以外で entry.[[Kind]]method なら、
    1. TypeError 例外を投げる。
  5. それ以外の場合、
    1. アサート: entry.[[Kind]]accessor である。
    2. もし entry.[[Set]]undefined なら、TypeError 例外を投げる。
    3. setterentry.[[Set]] とする。
    4. Call(setter, O, « value ») を実行する。
  6. unused を返す。

7.3.32 DefineField ( receiver, fieldRecord )

抽象操作 DefineField は、引数 receiver(オブジェクト)、fieldRecordClassFieldDefinition Record)を受け取り、normal completion containingunused または throw completion を返します。呼び出されたとき、次の手順を実行します:

  1. fieldNamefieldRecord.[[Name]] とする。
  2. initializerfieldRecord.[[Initializer]] とする。
  3. もし initializerempty でないなら、
    1. initValue を ? Call(initializer, receiver) とする。
  4. それ以外の場合、
    1. initValueundefined とする。
  5. もし fieldNamePrivate Name なら、
    1. PrivateFieldAdd(receiver, fieldName, initValue) を実行する。
  6. それ以外の場合、
    1. アサート: fieldNameプロパティキー である。
    2. CreateDataPropertyOrThrow(receiver, fieldName, initValue) を実行する。
  7. unused を返す。

7.3.33 InitializeInstanceElements ( O, constructor )

抽象操作 InitializeInstanceElements は、引数 O(オブジェクト)、constructor(ECMAScript 関数オブジェクト)を受け取り、normal completion containingunused または throw completion を返します。呼び出されたとき、次の手順を実行します:

  1. methodsconstructor.[[PrivateMethods]] とする。
  2. methods の各 PrivateElement method について、
    1. PrivateMethodOrAccessorAdd(O, method) を実行する。
  3. fieldsconstructor.[[Fields]] とする。
  4. fields の各要素 fieldRecord について、
    1. DefineField(O, fieldRecord) を実行する。
  5. unused を返す。

7.3.34 AddValueToKeyedGroup ( groups, key, value )

抽象操作 AddValueToKeyedGroup は、引数 groupsリストRecord(フィールド [[Key]]ECMAScript 言語値)、[[Elements]]リストECMAScript 言語値)))、keyECMAScript 言語値)、valueECMAScript 言語値)を受け取り、unused を返します。呼び出されたとき、次の手順を実行します:

  1. groups の各 Record { [[Key]], [[Elements]] } g について:
    1. もし SameValue(g.[[Key]], key) が true なら、
      1. アサート: この条件を満たす groups の要素は正確に1つだけ。
      2. valueg.[[Elements]] に追加する。
      3. unused を返す。
  2. groupRecord { [[Key]]: key, [[Elements]]: « value » } とする。
  3. groupgroups に追加する。
  4. unused を返す。

7.3.35 GroupBy ( items, callback, keyCoercion )

抽象操作 GroupBy は、引数 itemsECMAScript 言語値)、callbackECMAScript 言語値)、keyCoercionproperty または collection)を受け取り、normal completion containingリストRecord(フィールド [[Key]]ECMAScript 言語値)、[[Elements]]リストECMAScript 言語値)))、または throw completion を返します。呼び出されたとき、次の手順を実行します:

  1. RequireObjectCoercible(items) を実行する。
  2. もし IsCallable(callback) が false なら、TypeError 例外を投げる。
  3. groups を新しい空の リスト とする。
  4. iteratorRecord を ? GetIterator(items, sync) とする。
  5. k を 0 とする。
  6. 繰り返し:
    1. もし k ≥ 253 - 1 なら、
      1. errorThrowCompletion(新しく作成された TypeError オブジェクト) とする。
      2. IteratorClose(iteratorRecord, error) を返す。
    2. next を ? IteratorStepValue(iteratorRecord) とする。
    3. もし nextdone なら、
      1. groups を返す。
    4. valuenext とする。
    5. keyCompletion(Call(callback, undefined, « value, 𝔽(k) » )) とする。
    6. IfAbruptCloseIterator(key, iteratorRecord) を実行する。
    7. もし keyCoercionproperty なら、
      1. keyCompletion(ToPropertyKey(key)) に設定する。
      2. IfAbruptCloseIterator(key, iteratorRecord) を実行する。
    8. それ以外の場合、
      1. アサート: keyCoercioncollection である。
      2. keyCanonicalizeKeyedCollectionKey(key) に設定する。
    9. AddValueToKeyedGroup(groups, key, value) を実行する。
    10. kk + 1 に設定する。

7.3.36 SetterThatIgnoresPrototypeProperties ( thisValue, home, p, v )

抽象操作 SetterThatIgnoresPrototypeProperties は、引数 thisValueECMAScript 言語値)、home(オブジェクト)、pプロパティキー)、vECMAScript 言語値)を受け取り、normal completion containingunused または throw completion を返します。呼び出されたとき、次の手順を実行します:

  1. もし thisValueオブジェクトでないなら、
    1. TypeError 例外を投げる。
  2. もし SameValue(thisValue, home) が true なら、
    1. 注:ここで例外を投げることで、home オブジェクトのデータプロパティが書き込み不可である場合の厳格モードコードでの代入をエミュレートする。
    2. TypeError 例外を投げる。
  3. desc を ? thisValue.[[GetOwnProperty]](p) とする。
  4. もし descundefined なら、
    1. CreateDataPropertyOrThrow(thisValue, p, v) を実行する。
  5. それ以外の場合、
    1. Set(thisValue, p, v, true) を実行する。
  6. unused を返す。

7.4 イテレータオブジェクトに対する操作

共通のイテレーションインターフェース(27.1)を参照。

7.4.1 イテレータレコード

イテレータレコード とは、Record 値であり、イテレータ または 非同期イテレータnext メソッドをカプセル化するために使用されます。

イテレータレコードは、表15 に挙げられているフィールドを持ちます。

表15: イテレータレコード のフィールド
フィールド名 意味
[[Iterator]] オブジェクト イテレータインターフェース または 非同期イテレータインターフェース を満たすオブジェクト。
[[NextMethod]] ECMAScript 言語値 [[Iterator]] オブジェクトの next メソッド。
[[Done]] Boolean イテレータ が完了またはクローズされたかどうか。

7.4.2 GetIteratorDirect ( obj )

抽象操作 GetIteratorDirect は、引数 obj(オブジェクト)を受け取り、normal completion containingイテレータレコード または throw completion を返します。呼び出されたとき、次の手順を実行します:

  1. nextMethod を ? Get(obj, "next") とする。
  2. iteratorRecordイテレータレコード { [[Iterator]]: obj, [[NextMethod]]: nextMethod, [[Done]]: false } とする。
  3. iteratorRecord を返す。

7.4.3 GetIteratorFromMethod ( obj, method )

抽象操作 GetIteratorFromMethod は、引数 objECMAScript 言語値)、method関数オブジェクト)を受け取り、normal completion containingイテレータレコード または throw completion を返します。呼び出されたとき、次の手順を実行します:

  1. iterator を ? Call(method, obj) とする。
  2. もし iteratorオブジェクトでないなら、TypeError 例外を投げる。
  3. GetIteratorDirect(iterator) を返す。

7.4.4 GetIterator ( obj, kind )

抽象操作 GetIterator は、引数 objECMAScript 言語値)、kindsync または async)を受け取り、normal completion containingイテレータレコード または throw completion を返します。呼び出されたとき、次の手順を実行します:

  1. もし kindasync なら、
    1. method を ? GetMethod(obj, %Symbol.asyncIterator%) とする。
    2. もし methodundefined なら、
      1. syncMethod を ? GetMethod(obj, %Symbol.iterator%) とする。
      2. もし syncMethodundefined なら、TypeError 例外を投げる。
      3. syncIteratorRecord を ? GetIteratorFromMethod(obj, syncMethod) とする。
      4. CreateAsyncFromSyncIterator(syncIteratorRecord) を返す。
  2. それ以外の場合、
    1. method を ? GetMethod(obj, %Symbol.iterator%) とする。
  3. もし methodundefined なら、TypeError 例外を投げる。
  4. GetIteratorFromMethod(obj, method) を返す。

7.4.5 GetIteratorFlattenable ( obj, primitiveHandling )

抽象操作 GetIteratorFlattenable は、引数 objECMAScript 言語値)、primitiveHandlingiterate-string-primitives または reject-primitives)を受け取り、normal completion containingイテレータレコード または throw completion を返します。呼び出されたとき、次の手順を実行します:

  1. もし objオブジェクトでないなら、
    1. もし primitiveHandlingreject-primitives なら、TypeError 例外を投げる。
    2. アサート: primitiveHandlingiterate-string-primitives である。
    3. もし obj文字列でないなら、TypeError 例外を投げる。
  2. method を ? GetMethod(obj, %Symbol.iterator%) とする。
  3. もし methodundefined なら、
    1. iteratorobj とする。
  4. それ以外の場合、
    1. iterator を ? Call(method, obj) とする。
  5. もし iteratorオブジェクトでないなら、TypeError 例外を投げる。
  6. GetIteratorDirect(iterator) を返す。

7.4.6 IteratorNext ( iteratorRecord [ , value ] )

抽象操作 IteratorNext は、引数 iteratorRecordイテレータレコード)、省略可能な valueECMAScript 言語値)を受け取り、normal completion containing なオブジェクト、または throw completion を返します。呼び出されたとき、次の手順を実行します:

  1. もし value が指定されていなければ、
    1. resultCompletion(Call(iteratorRecord.[[NextMethod]], iteratorRecord.[[Iterator]])) とする。
  2. それ以外の場合、
    1. resultCompletion(Call(iteratorRecord.[[NextMethod]], iteratorRecord.[[Iterator]], « value »)) とする。
  3. もし resultthrow completion なら、
    1. iteratorRecord.[[Done]]true に設定する。
    2. result を返す。
  4. result を ! result に設定する。
  5. もし resultオブジェクトでないなら、
    1. iteratorRecord.[[Done]]true に設定する。
    2. TypeError 例外を投げる。
  6. result を返す。

7.4.7 IteratorComplete ( iteratorResult )

抽象操作 IteratorComplete は、引数 iteratorResult(オブジェクト)を受け取り、normal completion containing な Boolean または throw completion を返します。呼び出されたとき、次の手順を実行します:

  1. ToBoolean(? Get(iteratorResult, "done")) を返す。

7.4.8 IteratorValue ( iteratorResult )

抽象操作 IteratorValue は、引数 iteratorResult(オブジェクト)を受け取り、normal completion containingECMAScript 言語値 または throw completion を返します。呼び出されたとき、次の手順を実行します:

  1. Get(iteratorResult, "value") を返す。

7.4.9 IteratorStep ( iteratorRecord )

抽象操作 IteratorStep は、引数 iteratorRecordイテレータレコード)を受け取り、normal completion containing なオブジェクトまたは done、あるいは throw completion を返します。これは iteratorRecord.[[Iterator]] から iteratorRecord.[[NextMethod]] を呼び出して次の値を取得し、イテレータが終端に到達した場合は done を、そうでなければ IteratorResult オブジェクト を返します。呼び出されたとき、次の手順を実行します:

  1. result を ? IteratorNext(iteratorRecord) とする。
  2. doneCompletion(IteratorComplete(result)) とする。
  3. もし donethrow completion なら、
    1. iteratorRecord.[[Done]]true に設定する。
    2. done を返す。
  4. done を ! done に設定する。
  5. もし donetrue なら、
    1. iteratorRecord.[[Done]]true に設定する。
    2. done を返す。
  6. result を返す。

7.4.10 IteratorStepValue ( iteratorRecord )

抽象操作 IteratorStepValue は、引数 iteratorRecordイテレータレコード)を受け取り、normal completion containingECMAScript 言語値 または done、あるいは throw completion を返します。これは iteratorRecord.[[Iterator]] から iteratorRecord.[[NextMethod]] を呼び出して次の値を取得し、イテレータが終端に到達した場合は done を、そうでなければ IteratorResult オブジェクト の値を返します。呼び出されたとき、次の手順を実行します:

  1. result を ? IteratorStep(iteratorRecord) とする。
  2. もし resultdone なら、
    1. done を返す。
  3. valueCompletion(IteratorValue(result)) とする。
  4. もし valuethrow completion なら、
    1. iteratorRecord.[[Done]]true に設定する。
  5. value を返す。

7.4.11 IteratorClose ( iteratorRecord, completion )

抽象操作 IteratorClose は、引数 iteratorRecordイテレータレコード)、completionCompletion Record)を受け取り、Completion Record を返します。これは イテレータ に対し、完了状態になったときに通常行うべき処理を通知するために使われます。呼び出されたとき、次の手順を実行します:

  1. アサート: iteratorRecord.[[Iterator]]オブジェクトである。
  2. iteratoriteratorRecord.[[Iterator]] とする。
  3. innerResultCompletion(GetMethod(iterator, "return")) とする。
  4. もし innerResultnormal completion なら、
    1. returninnerResult.[[Value]] とする。
    2. もし returnundefined なら、? completion を返す。
    3. innerResultCompletion(Call(return, iterator)) に設定する。
  5. もし completionthrow completion なら、? completion を返す。
  6. もし innerResultthrow completion なら、? innerResult を返す。
  7. もし innerResult.[[Value]]オブジェクトでないなら、TypeError 例外を投げる。
  8. completion を返す。

7.4.12 IfAbruptCloseIterator ( value, iteratorRecord )

IfAbruptCloseIterator は イテレータレコード を使う一連のアルゴリズムステップの省略記法です。次の形式のアルゴリズムステップ:

  1. IfAbruptCloseIterator(value, iteratorRecord)。

は、次と同じ意味になります:

  1. アサート: valueCompletion Record である。
  2. もし valueabrupt completion なら、? IteratorClose(iteratorRecord, value) を返す。
  3. それ以外の場合、value を ! value に設定する。

7.4.13 AsyncIteratorClose ( iteratorRecord, completion )

抽象操作 AsyncIteratorClose は、引数 iteratorRecordイテレータレコード)、completionCompletion Record)を受け取り、Completion Record を返します。これは 非同期イテレータ に対し、完了状態になったときに通常行うべき処理を通知するために使われます。呼び出されたとき、次の手順を実行します:

  1. アサート: iteratorRecord.[[Iterator]]オブジェクトである。
  2. iteratoriteratorRecord.[[Iterator]] とする。
  3. innerResultCompletion(GetMethod(iterator, "return")) とする。
  4. もし innerResultnormal completion なら、
    1. returninnerResult.[[Value]] とする。
    2. もし returnundefined なら、? completion を返す。
    3. innerResultCompletion(Call(return, iterator)) に設定する。
    4. もし innerResultnormal completion なら、innerResultCompletion(Await(innerResult.[[Value]])) に設定する。
  5. もし completionthrow completion なら、? completion を返す。
  6. もし innerResultthrow completion なら、? innerResult を返す。
  7. もし innerResult.[[Value]]オブジェクトでないなら、TypeError 例外を投げる。
  8. completion を返す。

7.4.14 CreateIteratorResultObject ( value, done )

抽象操作 CreateIteratorResultObject は、引数 valueECMAScript 言語値)、done(Boolean)を受け取り、IteratorResult インターフェースに準拠するオブジェクトを返します。これはIteratorResult インターフェースに準拠するオブジェクトを生成します。呼び出されたとき、次の手順を実行します:

  1. objOrdinaryObjectCreate(%Object.prototype%) とする。
  2. CreateDataPropertyOrThrow(obj, "value", value) を実行する。
  3. CreateDataPropertyOrThrow(obj, "done", done) を実行する。
  4. obj を返す。

7.4.15 CreateListIteratorRecord ( list )

抽象操作 CreateListIteratorRecord は、引数 listリストECMAScript 言語値のリスト)を受け取り、イテレータレコード を返します。これは [[NextMethod]]list の各要素を順に返す イテレータレコード を生成します。呼び出されたとき、次の手順を実行します:

  1. closure を引数なしで list をキャプチャし、呼び出されたとき以下の手順を実行する新しい Abstract Closure とする:
    1. list の各要素 E について、
      1. GeneratorYield(CreateIteratorResultObject(E, false)) を実行する。
    2. NormalCompletion(undefined) を返す。
  2. iteratorCreateIteratorFromClosure(closure, empty, %Iterator.prototype%) とする。
  3. イテレータレコード { [[Iterator]]: iterator, [[NextMethod]]: %GeneratorPrototype.next%, [[Done]]: false } を返す。

リストイテレータオブジェクトは ECMAScript コードから直接アクセスできません。

7.4.16 IteratorToList ( iteratorRecord )

抽象操作 IteratorToList は、引数 iteratorRecordイテレータレコード)を受け取り、normal completion containingリストECMAScript 言語値のリスト、または throw completion を返します。呼び出されたとき、次の手順を実行します:

  1. values を新しい空の リスト とする。
  2. 繰り返し:
    1. next を ? IteratorStepValue(iteratorRecord) とする。
    2. もし nextdone なら、
      1. values を返す。
    3. nextvalues に追加する。

8 構文指向操作

この節で定義されているものに加えて、特化された 構文指向操作 が本仕様書の各所で定義されています。

8.1 実行時セマンティクス: 評価

構文指向操作 Evaluation は引数を取らず、Completion Record を返します。

この操作の定義は、本仕様書の「ECMAScript 言語」セクションに分散して記述されています。各定義は、関連する生成規則の定義箇所の直後に記載されています。

8.2 スコープ解析

8.2.1 静的セマンティクス: BoundNames

構文指向操作 BoundNames は引数を取らず、文字列のリストを返します。

"*default*" は、他の名前を持たないモジュールのデフォルトエクスポートに対する合成名として本仕様書内で使用されます。その名前でモジュールの [[Environment]] にエントリが作成され、対応する値が格納されます。また、モジュールに対して ResolveExport ( exportName [ , resolveSet ] ) を呼び出して "default" という名前のエクスポートを解決すると、[[BindingName]]"*default*" である ResolvedBinding Record が返され、これがモジュールの [[Environment]] で上記の値に解決されます。これは仕様記述を容易にするためだけに行われており、匿名のデフォルトエクスポートも他のエクスポートと同様に解決できるようになっています。この "*default*" という文字列は、ECMAScript コードやモジュールリンクアルゴリズムからアクセスされることはありません。

これは以下の生成規則ごとに分割定義されています:

束縛識別子 識別子
  1. リストを返す。その唯一の要素はStringValueであり、識別子の値である。
束縛識別子 yield
  1. « "yield" »を返す。
束縛識別子 await
  1. « "await" »を返す。
レキシカル宣言 LetまたはConst 束縛リスト ;
  1. 束縛名束縛リストについて返す。
束縛リスト 束縛リスト , レキシカル束縛
  1. names1を、束縛名束縛リストについて)とする。
  2. names2を、束縛名レキシカル束縛について)とする。
  3. リスト連結によってnames1names2を結合して返す。
レキシカル束縛 束縛識別子 初期化子オプション
  1. 束縛名束縛識別子について返す。
レキシカル束縛 束縛パターン 初期化子
  1. 束縛名束縛パターンについて返す。
変数宣言リスト 変数宣言リスト , 変数宣言
  1. names1束縛名変数宣言リストについて)とする。
  2. names2束縛名変数宣言について)とする。
  3. リスト連結によって names1names2 を結合して返す。
変数宣言 束縛識別子 初期化子オプション
  1. 束縛名束縛識別子について返す。
変数宣言 束縛パターン 初期化子
  1. 束縛名束縛パターンについて返す。
オブジェクト束縛パターン { }
  1. 新しい空のリストを返す。
オブジェクト束縛パターン { 束縛プロパティリスト , 束縛残余プロパティ }
  1. names1束縛名束縛プロパティリストについて)とする。
  2. names2束縛名束縛残余プロパティについて)とする。
  3. リスト連結によって names1names2 を結合して返す。
配列束縛パターン [ 省略オプション ]
  1. 新しい空のリストを返す。
配列束縛パターン [ 省略オプション 束縛残余要素 ]
  1. 束縛名束縛残余要素について返す。
配列束縛パターン [ 束縛要素リスト , 省略オプション ]
  1. 束縛名束縛要素リストについて返す。
配列束縛パターン [ 束縛要素リスト , 省略オプション 束縛残余要素 ]
  1. names1束縛名束縛要素リストについて)とする。
  2. names2束縛名束縛残余要素について)とする。
  3. リスト連結によって names1names2 を結合して返す。
束縛プロパティリスト 束縛プロパティリスト , 束縛プロパティ
  1. names1束縛名束縛プロパティリストについて)とする。
  2. names2束縛名束縛プロパティについて)とする。
  3. リスト連結によって names1names2 を結合して返す。
束縛要素リスト 束縛要素リスト , 省略束縛要素
  1. names1束縛名束縛要素リストについて)とする。
  2. names2束縛名省略束縛要素について)とする。
  3. リスト連結によって names1names2 を結合して返す。
省略束縛要素 省略オプション 束縛要素
  1. 束縛名束縛要素について返す。
束縛プロパティ プロパティ名 : 束縛要素
  1. 束縛名束縛要素について返す。
単一名束縛 束縛識別子 初期化子オプション
  1. 束縛名束縛識別子について返す。
束縛要素 束縛パターン 初期化子オプション
  1. 束縛名束縛パターンについて返す。
For宣言 LetまたはConst For束縛
  1. 束縛名For束縛について返す。
FunctionDeclaration function BindingIdentifier ( FormalParameters ) { FunctionBody }
  1. BoundNamesBindingIdentifier に対して返す。
FunctionDeclaration function ( FormalParameters ) { FunctionBody }
  1. « "*default*" » を返す。
FormalParameters [空]
  1. 新しい空の List を返す。
FormalParameters FormalParameterList , FunctionRestParameter
  1. names1BoundNamesFormalParameterList で取得する。
  2. names2BoundNamesFunctionRestParameter で取得する。
  3. names1names2リスト連結 を返す。
FormalParameterList FormalParameterList , FormalParameter
  1. names1BoundNamesFormalParameterList で取得する。
  2. names2BoundNamesFormalParameter で取得する。
  3. names1names2リスト連結 を返す。
ArrowParameters CoverParenthesizedExpressionAndArrowParameterList
  1. formalsArrowFormalParameters で、cover されている CoverParenthesizedExpressionAndArrowParameterList から取得する。
  2. formalsBoundNames を返す。
GeneratorDeclaration function * BindingIdentifier ( FormalParameters ) { GeneratorBody }
  1. BoundNamesBindingIdentifier に対して返す。
GeneratorDeclaration function * ( FormalParameters ) { GeneratorBody }
  1. « "*default*" » を返す。
AsyncGeneratorDeclaration async function * BindingIdentifier ( FormalParameters ) { AsyncGeneratorBody }
  1. BoundNamesBindingIdentifier に対して返す。
AsyncGeneratorDeclaration async function * ( FormalParameters ) { AsyncGeneratorBody }
  1. « "*default*" » を返す。
ClassDeclaration class BindingIdentifier ClassTail
  1. BoundNamesBindingIdentifier に対して返す。
ClassDeclaration class ClassTail
  1. « "*default*" » を返す。
AsyncFunctionDeclaration async function BindingIdentifier ( FormalParameters ) { AsyncFunctionBody }
  1. BoundNamesBindingIdentifier に対して返す。
AsyncFunctionDeclaration async function ( FormalParameters ) { AsyncFunctionBody }
  1. « "*default*" » を返す。
CoverCallExpressionAndAsyncArrowHead MemberExpression Arguments
  1. headAsyncArrowHead で、cover されている CoverCallExpressionAndAsyncArrowHead から取得する。
  2. headBoundNames を返す。
ImportDeclaration import ImportClause FromClause WithClauseopt ;
  1. BoundNamesImportClause に対して返す。
ImportDeclaration import ModuleSpecifier WithClauseopt ;
  1. 新しい空の List を返す。
ImportClause ImportedDefaultBinding , NameSpaceImport
  1. names1BoundNamesImportedDefaultBinding で取得する。
  2. names2BoundNamesNameSpaceImport で取得する。
  3. names1names2リスト連結 を返す。
ImportClause ImportedDefaultBinding , NamedImports
  1. names1BoundNamesImportedDefaultBinding で取得する。
  2. names2BoundNamesNamedImports で取得する。
  3. names1names2リスト連結 を返す。
NamedImports { }
  1. 新しい空の List を返す。
ImportsList ImportsList , ImportSpecifier
  1. names1BoundNamesImportsList で取得する。
  2. names2BoundNamesImportSpecifier で取得する。
  3. names1names2リスト連結 を返す。
ImportSpecifier ModuleExportName as ImportedBinding
  1. BoundNamesImportedBinding に対して返す。
ExportDeclaration export ExportFromClause FromClause WithClauseopt ; export NamedExports ;
  1. 新しい空の List を返す。
ExportDeclaration export VariableStatement
  1. BoundNamesVariableStatement に対して返す。
ExportDeclaration export Declaration
  1. BoundNamesDeclaration に対して返す。
ExportDeclaration export default HoistableDeclaration
  1. declarationNamesBoundNamesHoistableDeclaration で取得する。
  2. もし declarationNames"*default*" 要素が含まれていなければ、"*default*"declarationNames に追加する。
  3. declarationNames を返す。
ExportDeclaration export default ClassDeclaration
  1. declarationNamesBoundNamesClassDeclaration で取得する。
  2. もし declarationNames"*default*" 要素が含まれていなければ、"*default*"declarationNames に追加する。
  3. declarationNames を返す。
ExportDeclaration export default AssignmentExpression ;
  1. « "*default*" » を返す。

8.2.2 静的セマンティクス:DeclarationPart

構文指向オペレーション DeclarationPart は引数を取らず、構文ノード を返す。これは次の生成規則ごとに個別に定義される:

HoistableDeclaration FunctionDeclaration
  1. FunctionDeclaration を返す。
HoistableDeclaration GeneratorDeclaration
  1. GeneratorDeclaration を返す。
HoistableDeclaration AsyncFunctionDeclaration
  1. AsyncFunctionDeclaration を返す。
HoistableDeclaration AsyncGeneratorDeclaration
  1. AsyncGeneratorDeclaration を返す。
Declaration ClassDeclaration
  1. ClassDeclaration を返す。
Declaration LexicalDeclaration
  1. LexicalDeclaration を返す。

8.2.3 静的セマンティクス:IsConstantDeclaration

構文指向オペレーション IsConstantDeclaration は引数を取らず、真偽値(Boolean)を返す。 これは次の生成規則ごとに個別に定義される:

LexicalDeclaration LetOrConst BindingList ;
  1. IsConstantDeclarationLetOrConst に対して返す。
LetOrConst let
  1. false を返す。
LetOrConst const
  1. true を返す。
FunctionDeclaration function BindingIdentifier ( FormalParameters ) { FunctionBody } function ( FormalParameters ) { FunctionBody } GeneratorDeclaration function * BindingIdentifier ( FormalParameters ) { GeneratorBody } function * ( FormalParameters ) { GeneratorBody } AsyncGeneratorDeclaration async function * BindingIdentifier ( FormalParameters ) { AsyncGeneratorBody } async function * ( FormalParameters ) { AsyncGeneratorBody } AsyncFunctionDeclaration async function BindingIdentifier ( FormalParameters ) { AsyncFunctionBody } async function ( FormalParameters ) { AsyncFunctionBody }
  1. false を返す。
ClassDeclaration class BindingIdentifier ClassTail class ClassTail
  1. false を返す。
ExportDeclaration export ExportFromClause FromClause ; export NamedExports ; export default AssignmentExpression ;
  1. false を返す。

export default AssignmentExpression を定数宣言として扱う必要はない。なぜなら、モジュールのデフォルトオブジェクトを参照するために使用される内部結合名に代入する構文は存在しないからである。

8.2.4 静的セマンティクス:LexicallyDeclaredNames

構文指向オペレーション LexicallyDeclaredNames は引数を取らず、文字列のリストを返す。これは次の生成規則ごとに個別に定義される。

Block { }
  1. 新しい空のリストを返す。
StatementList StatementList StatementListItem
  1. names1LexicallyDeclaredNamesStatementList で取得する。
  2. names2LexicallyDeclaredNamesStatementListItem で取得する。
  3. names1names2リスト連結 を返す。
StatementListItem Statement
  1. もし Statement Statement LabelledStatement の場合、LexicallyDeclaredNamesLabelledStatement を返す。
  2. 新しい空のリストを返す。
StatementListItem Declaration
  1. BoundNamesDeclaration に対して返す。
CaseBlock { }
  1. 新しい空のリストを返す。
CaseBlock { CaseClausesopt DefaultClause CaseClausesopt }
  1. 最初の CaseClauses が存在する場合、names1LexicallyDeclaredNames の最初の CaseClauses で取得する。
  2. そうでなければ、names1 を新しい空のリストとする。
  3. names2LexicallyDeclaredNamesDefaultClause で取得する。
  4. 2番目の CaseClauses が存在する場合、names3LexicallyDeclaredNames の2番目の CaseClauses で取得する。
  5. そうでなければ、names3 を新しい空のリストとする。
  6. names1names2names3リスト連結 を返す。
CaseClauses CaseClauses CaseClause
  1. names1LexicallyDeclaredNamesCaseClauses で取得する。
  2. names2LexicallyDeclaredNamesCaseClause で取得する。
  3. names1names2リスト連結 を返す。
CaseClause case Expression StatementListopt
  1. StatementList が存在する場合、LexicallyDeclaredNamesStatementList を返す。
  2. 新しい空のリストを返す。
DefaultClause default StatementListopt
  1. StatementList が存在する場合、LexicallyDeclaredNamesStatementList を返す。
  2. 新しい空のリストを返す。
LabelledStatement LabelIdentifier LabelledItem
  1. LexicallyDeclaredNamesLabelledItem に対して返す。
LabelledItem Statement
  1. 新しい空のリストを返す。
LabelledItem FunctionDeclaration
  1. BoundNamesFunctionDeclaration に対して返す。
FunctionStatementList [空]
  1. 新しい空のリストを返す。
FunctionStatementList StatementList
  1. TopLevelLexicallyDeclaredNamesStatementList に対して返す。
ClassStaticBlockStatementList [空]
  1. 新しい空のリストを返す。
ClassStaticBlockStatementList StatementList
  1. TopLevelLexicallyDeclaredNamesStatementList に対して返す。
ConciseBody ExpressionBody
  1. 新しい空のリストを返す。
AsyncConciseBody ExpressionBody
  1. 新しい空のリストを返す。
Script [空]
  1. 新しい空のリストを返す。
ScriptBody StatementList
  1. TopLevelLexicallyDeclaredNamesStatementList に対して返す。
注1

Script のトップレベルでは、関数宣言はレキシカル宣言ではなく var 宣言として扱われる。

注2

Module の LexicallyDeclaredNames には、すべてのインポート束縛の名前も含まれる。

ModuleItemList ModuleItemList ModuleItem
  1. names1LexicallyDeclaredNamesModuleItemList で取得する。
  2. names2LexicallyDeclaredNamesModuleItem で取得する。
  3. names1names2リスト連結 を返す。
ModuleItem ImportDeclaration
  1. BoundNamesImportDeclaration に対して返す。
ModuleItem ExportDeclaration
  1. ExportDeclarationexport VariableStatement の場合、新しい空のリストを返す。
  2. BoundNamesExportDeclaration に対して返す。
ModuleItem StatementListItem
  1. LexicallyDeclaredNamesStatementListItem に対して返す。
注3

Module のトップレベルでは、関数宣言は var 宣言ではなくレキシカル宣言として扱われる。

8.2.5 静的セマンティクス:LexicallyScopedDeclarations

構文指向オペレーション LexicallyScopedDeclarations は引数を取らず、リスト(要素は 構文ノード)を返す。これは次の生成規則ごとに個別に定義される。

StatementList StatementList StatementListItem
  1. declarations1LexicallyScopedDeclarationsStatementList で取得する。
  2. declarations2LexicallyScopedDeclarationsStatementListItem で取得する。
  3. declarations1declarations2リスト連結 を返す。
StatementListItem Statement
  1. もし Statement Statement LabelledStatement の場合、LexicallyScopedDeclarationsLabelledStatement を返す。
  2. 新しい空のリストを返す。
StatementListItem Declaration
  1. リスト(唯一の要素は DeclarationPart of Declaration)を返す。
CaseBlock { }
  1. 新しい空のリストを返す。
CaseBlock { CaseClausesopt DefaultClause CaseClausesopt }
  1. 最初の CaseClauses が存在する場合、declarations1LexicallyScopedDeclarations の最初の CaseClauses で取得する。
  2. そうでなければ、declarations1 を新しい空のリストとする。
  3. declarations2LexicallyScopedDeclarationsDefaultClause で取得する。
  4. 2番目の CaseClauses が存在する場合、declarations3LexicallyScopedDeclarations の2番目の CaseClauses で取得する。
  5. そうでなければ、declarations3 を新しい空のリストとする。
  6. declarations1declarations2declarations3リスト連結 を返す。
CaseClauses CaseClauses CaseClause
  1. declarations1LexicallyScopedDeclarationsCaseClauses で取得する。
  2. declarations2LexicallyScopedDeclarationsCaseClause で取得する。
  3. declarations1declarations2リスト連結 を返す。
CaseClause case Expression StatementListopt
  1. StatementList が存在する場合、LexicallyScopedDeclarationsStatementList を返す。
  2. 新しい空のリストを返す。
DefaultClause default StatementListopt
  1. StatementList が存在する場合、LexicallyScopedDeclarationsStatementList を返す。
  2. 新しい空のリストを返す。
LabelledStatement LabelIdentifier LabelledItem
  1. LexicallyScopedDeclarationsLabelledItem に対して返す。
LabelledItem Statement
  1. 新しい空のリストを返す。
LabelledItem FunctionDeclaration
  1. « FunctionDeclaration » を返す。
FunctionStatementList [空]
  1. 新しい空のリストを返す。
FunctionStatementList StatementList
  1. TopLevelLexicallyScopedDeclarationsStatementList に対して返す。
ClassStaticBlockStatementList [空]
  1. 新しい空のリストを返す。
ClassStaticBlockStatementList StatementList
  1. TopLevelLexicallyScopedDeclarationsStatementList に対して返す。
ConciseBody ExpressionBody
  1. 新しい空のリストを返す。
AsyncConciseBody ExpressionBody
  1. 新しい空のリストを返す。
Script [空]
  1. 新しい空のリストを返す。
ScriptBody StatementList
  1. TopLevelLexicallyScopedDeclarationsStatementList に対して返す。
Module [空]
  1. 新しい空のリストを返す。
ModuleItemList ModuleItemList ModuleItem
  1. declarations1LexicallyScopedDeclarationsModuleItemList で取得する。
  2. declarations2LexicallyScopedDeclarationsModuleItem で取得する。
  3. declarations1declarations2リスト連結 を返す。
ModuleItem ImportDeclaration
  1. 新しい空のリストを返す。
ExportDeclaration export ExportFromClause FromClause WithClauseopt ; export NamedExports ; export VariableStatement
  1. 新しい空のリストを返す。
ExportDeclaration export Declaration
  1. リスト(唯一の要素は DeclarationPart of Declaration)を返す。
ExportDeclaration export default HoistableDeclaration
  1. リスト(唯一の要素は DeclarationPart of HoistableDeclaration)を返す。
ExportDeclaration export default ClassDeclaration
  1. リスト(唯一の要素は ClassDeclaration)を返す。
ExportDeclaration export default AssignmentExpression ;
  1. リスト(唯一の要素はこの ExportDeclaration)を返す。

8.2.6 静的セマンティクス:VarDeclaredNames

構文指向オペレーション VarDeclaredNames は引数を取らず、文字列のリストを返す。これは次の生成規則ごとに個別に定義される:

Statement EmptyStatement ExpressionStatement ContinueStatement BreakStatement ReturnStatement ThrowStatement DebuggerStatement
  1. 新しい空のリストを返す。
Block { }
  1. 新しい空のリストを返す。
StatementList StatementList StatementListItem
  1. names1VarDeclaredNamesStatementList で取得する。
  2. names2VarDeclaredNamesStatementListItem で取得する。
  3. names1names2リスト連結 を返す。
StatementListItem Declaration
  1. 新しい空のリストを返す。
VariableStatement var VariableDeclarationList ;
  1. BoundNamesVariableDeclarationList に対して返す。
IfStatement if ( Expression ) Statement else Statement
  1. names1VarDeclaredNames の 最初の Statement で取得する。
  2. names2VarDeclaredNames の 2番目の Statement で取得する。
  3. names1names2リスト連結 を返す。
IfStatement if ( Expression ) Statement
  1. VarDeclaredNamesStatement に対して返す。
DoWhileStatement do Statement while ( Expression ) ;
  1. VarDeclaredNamesStatement に対して返す。
WhileStatement while ( Expression ) Statement
  1. VarDeclaredNamesStatement に対して返す。
ForStatement for ( Expressionopt ; Expressionopt ; Expressionopt ) Statement
  1. VarDeclaredNamesStatement に対して返す。
ForStatement for ( var VariableDeclarationList ; Expressionopt ; Expressionopt ) Statement
  1. names1BoundNamesVariableDeclarationList で取得する。
  2. names2VarDeclaredNamesStatement で取得する。
  3. names1names2リスト連結 を返す。
ForStatement for ( LexicalDeclaration Expressionopt ; Expressionopt ) Statement
  1. VarDeclaredNamesStatement に対して返す。
ForInOfStatement for ( LeftHandSideExpression in Expression ) Statement for ( ForDeclaration in Expression ) Statement for ( LeftHandSideExpression of AssignmentExpression ) Statement for ( ForDeclaration of AssignmentExpression ) Statement for await ( LeftHandSideExpression of AssignmentExpression ) Statement for await ( ForDeclaration of AssignmentExpression ) Statement
  1. VarDeclaredNamesStatement に対して返す。
ForInOfStatement for ( var ForBinding in Expression ) Statement for ( var ForBinding of AssignmentExpression ) Statement for await ( var ForBinding of AssignmentExpression ) Statement
  1. names1BoundNamesForBinding で取得する。
  2. names2VarDeclaredNamesStatement で取得する。
  3. names1names2リスト連結 を返す。

このセクションは付録 B.3.5 によって拡張される。

WithStatement with ( Expression ) Statement
  1. VarDeclaredNamesStatement に対して返す。
SwitchStatement switch ( Expression ) CaseBlock
  1. VarDeclaredNamesCaseBlock に対して返す。
CaseBlock { }
  1. 新しい空のリストを返す。
CaseBlock { CaseClausesopt DefaultClause CaseClausesopt }
  1. 最初の CaseClauses が存在する場合、names1VarDeclaredNames の 最初の CaseClauses で取得する。
  2. そうでなければ、names1 を新しい空のリストとする。
  3. names2VarDeclaredNamesDefaultClause で取得する。
  4. 2番目の CaseClauses が存在する場合、names3VarDeclaredNames の 2番目の CaseClauses で取得する。
  5. そうでなければ、names3 を新しい空のリストとする。
  6. names1names2names3リスト連結 を返す。
CaseClauses CaseClauses CaseClause
  1. names1VarDeclaredNamesCaseClauses で取得する。
  2. names2VarDeclaredNamesCaseClause で取得する。
  3. names1names2リスト連結 を返す。
CaseClause case Expression StatementListopt
  1. StatementList が存在する場合、VarDeclaredNamesStatementList に対して返す。
  2. 新しい空のリストを返す。
DefaultClause default StatementListopt
  1. StatementList が存在する場合、VarDeclaredNamesStatementList に対して返す。
  2. 新しい空のリストを返す。
LabelledStatement LabelIdentifier LabelledItem
  1. VarDeclaredNamesLabelledItem に対して返す。
LabelledItem FunctionDeclaration
  1. 新しい空のリストを返す。
TryStatement try Block Catch
  1. names1VarDeclaredNamesBlock で取得する。
  2. names2VarDeclaredNamesCatch で取得する。
  3. names1names2リスト連結 を返す。
TryStatement try Block Finally
  1. names1VarDeclaredNamesBlock で取得する。
  2. names2VarDeclaredNamesFinally で取得する。
  3. names1names2リスト連結 を返す。
TryStatement try Block Catch Finally
  1. names1VarDeclaredNamesBlock で取得する。
  2. names2VarDeclaredNamesCatch で取得する。
  3. names3VarDeclaredNamesFinally で取得する。
  4. names1names2names3リスト連結 を返す。
Catch catch ( CatchParameter ) Block
  1. VarDeclaredNamesBlock に対して返す。
FunctionStatementList [空]
  1. 新しい空のリストを返す。
FunctionStatementList StatementList
  1. TopLevelVarDeclaredNamesStatementList に対して返す。
ClassStaticBlockStatementList [空]
  1. 新しい空のリストを返す。
ClassStaticBlockStatementList StatementList
  1. TopLevelVarDeclaredNamesStatementList に対して返す。
ConciseBody ExpressionBody
  1. 新しい空のリストを返す。
AsyncConciseBody ExpressionBody
  1. 新しい空のリストを返す。
Script [空]
  1. 新しい空のリストを返す。
ScriptBody StatementList
  1. TopLevelVarDeclaredNamesStatementList に対して返す。
ModuleItemList ModuleItemList ModuleItem
  1. names1VarDeclaredNamesModuleItemList で取得する。
  2. names2VarDeclaredNamesModuleItem で取得する。
  3. names1names2リスト連結 を返す。
ModuleItem ImportDeclaration
  1. 新しい空のリストを返す。
ModuleItem ExportDeclaration
  1. ExportDeclarationexport VariableStatement の場合、BoundNamesExportDeclaration に対して返す。
  2. 新しい空のリストを返す。

8.2.7 静的セマンティクス:VarScopedDeclarations

構文指向オペレーション VarScopedDeclarations は引数を取らず、リスト(要素は 構文ノード)を返す。これは次の生成規則ごとに個別に定義される。

Statement EmptyStatement ExpressionStatement ContinueStatement BreakStatement ReturnStatement ThrowStatement DebuggerStatement
  1. 新しい空のリストを返す。
Block { }
  1. 新しい空のリストを返す。
StatementList StatementList StatementListItem
  1. declarations1VarScopedDeclarationsStatementList で取得する。
  2. declarations2VarScopedDeclarationsStatementListItem で取得する。
  3. declarations1declarations2リスト連結 を返す。
StatementListItem Declaration
  1. 新しい空のリストを返す。
VariableDeclarationList VariableDeclaration
  1. « VariableDeclaration » を返す。
VariableDeclarationList VariableDeclarationList , VariableDeclaration
  1. declarations1VarScopedDeclarationsVariableDeclarationList で取得する。
  2. declarations1 と « VariableDeclaration » の リスト連結 を返す。
IfStatement if ( Expression ) Statement else Statement
  1. declarations1VarScopedDeclarations の最初の Statement で取得する。
  2. declarations2VarScopedDeclarations の2番目の Statement で取得する。
  3. declarations1declarations2リスト連結 を返す。
IfStatement if ( Expression ) Statement
  1. VarScopedDeclarationsStatement に対して返す。
DoWhileStatement do Statement while ( Expression ) ;
  1. VarScopedDeclarationsStatement に対して返す。
WhileStatement while ( Expression ) Statement
  1. VarScopedDeclarationsStatement に対して返す。
ForStatement for ( Expressionopt ; Expressionopt ; Expressionopt ) Statement
  1. VarScopedDeclarationsStatement に対して返す。
ForStatement for ( var VariableDeclarationList ; Expressionopt ; Expressionopt ) Statement
  1. declarations1VarScopedDeclarationsVariableDeclarationList で取得する。
  2. declarations2VarScopedDeclarationsStatement で取得する。
  3. declarations1declarations2リスト連結 を返す。
ForStatement for ( LexicalDeclaration Expressionopt ; Expressionopt ) Statement
  1. VarScopedDeclarationsStatement に対して返す。
ForInOfStatement for ( LeftHandSideExpression in Expression ) Statement for ( ForDeclaration in Expression ) Statement for ( LeftHandSideExpression of AssignmentExpression ) Statement for ( ForDeclaration of AssignmentExpression ) Statement for await ( LeftHandSideExpression of AssignmentExpression ) Statement for await ( ForDeclaration of AssignmentExpression ) Statement
  1. VarScopedDeclarationsStatement に対して返す。
ForInOfStatement for ( var ForBinding in Expression ) Statement for ( var ForBinding of AssignmentExpression ) Statement for await ( var ForBinding of AssignmentExpression ) Statement
  1. declarations1 を « ForBinding » とする。
  2. declarations2VarScopedDeclarationsStatement で取得する。
  3. declarations1declarations2リスト連結 を返す。

このセクションは付属書 B.3.5 によって拡張される。

WithStatement with ( Expression ) Statement
  1. VarScopedDeclarationsStatement に対して返す。
SwitchStatement switch ( Expression ) CaseBlock
  1. VarScopedDeclarationsCaseBlock に対して返す。
CaseBlock { }
  1. 新しい空のリストを返す。
CaseBlock { CaseClausesopt DefaultClause CaseClausesopt }
  1. 最初の CaseClauses が存在する場合、declarations1VarScopedDeclarations の最初の CaseClauses で取得する。
  2. そうでなければ、declarations1 を新しい空のリストとする。
  3. declarations2VarScopedDeclarationsDefaultClause で取得する。
  4. 2番目の CaseClauses が存在する場合、declarations3VarScopedDeclarations の2番目の CaseClauses で取得する。
  5. そうでなければ、declarations3 を新しい空のリストとする。
  6. declarations1declarations2declarations3リスト連結 を返す。
CaseClauses CaseClauses CaseClause
  1. declarations1VarScopedDeclarationsCaseClauses で取得する。
  2. declarations2VarScopedDeclarationsCaseClause で取得する。
  3. declarations1declarations2リスト連結 を返す。
CaseClause case Expression StatementListopt
  1. StatementList が存在する場合、VarScopedDeclarationsStatementList を返す。
  2. 新しい空のリストを返す。
DefaultClause default StatementListopt
  1. StatementList が存在する場合、VarScopedDeclarationsStatementList を返す。
  2. 新しい空のリストを返す。
LabelledStatement LabelIdentifier LabelledItem
  1. VarScopedDeclarationsLabelledItem に対して返す。
LabelledItem FunctionDeclaration
  1. 新しい空のリストを返す。
TryStatement try Block Catch
  1. declarations1VarScopedDeclarationsBlock で取得する。
  2. declarations2VarScopedDeclarationsCatch で取得する。
  3. declarations1declarations2リスト連結 を返す。
TryStatement try Block Finally
  1. declarations1VarScopedDeclarationsBlock で取得する。
  2. declarations2VarScopedDeclarationsFinally で取得する。
  3. declarations1declarations2リスト連結 を返す。
TryStatement try Block Catch Finally
  1. declarations1VarScopedDeclarationsBlock で取得する。
  2. declarations2VarScopedDeclarationsCatch で取得する。
  3. declarations3VarScopedDeclarationsFinally で取得する。
  4. declarations1declarations2declarations3リスト連結 を返す。
Catch catch ( CatchParameter ) Block
  1. VarScopedDeclarationsBlock に対して返す。
FunctionStatementList [空]
  1. 新しい空のリストを返す。
FunctionStatementList StatementList
  1. TopLevelVarScopedDeclarationsStatementList に対して返す。
ClassStaticBlockStatementList [空]
  1. 新しい空のリストを返す。
ClassStaticBlockStatementList StatementList
  1. TopLevelVarScopedDeclarationsStatementList に対して返す。
ConciseBody ExpressionBody
  1. 新しい空のリストを返す。
AsyncConciseBody ExpressionBody
  1. 新しい空のリストを返す。
Script [空]
  1. 新しい空のリストを返す。
ScriptBody StatementList
  1. TopLevelVarScopedDeclarationsStatementList に対して返す。
Module [空]
  1. 新しい空のリストを返す。
ModuleItemList ModuleItemList ModuleItem
  1. declarations1VarScopedDeclarationsModuleItemList で取得する。
  2. declarations2VarScopedDeclarationsModuleItem で取得する。
  3. declarations1declarations2リスト連結 を返す。
ModuleItem ImportDeclaration
  1. 新しい空のリストを返す。
ModuleItem ExportDeclaration
  1. ExportDeclarationexport VariableStatement の場合、VarScopedDeclarationsVariableStatement に対して返す。
  2. 新しい空のリストを返す。

8.2.8 静的セマンティクス:TopLevelLexicallyDeclaredNames

構文指向オペレーション TopLevelLexicallyDeclaredNamesは引数を取らず、 文字列のリストを返す。それは次の生成規則ごとに定義される:

StatementList : StatementList StatementListItem
  1. names1を、TopLevelLexicallyDeclaredNamesStatementListに対する値とする。
  2. names2を、TopLevelLexicallyDeclaredNamesStatementListItemに対する値とする。
  3. リスト連結names1names2を返す。
StatementListItem : Statement
  1. 新しい空のリストを返す。
StatementListItem : Declaration
  1. もしDeclaration Declaration : HoistableDeclaration ならば、
    1. 新しい空のリストを返す。
  2. BoundNamesDeclarationに対する値を返す。

関数またはスクリプトのトップレベルでは、function宣言はレキシカル宣言ではなくvar宣言として扱われる。

8.2.9 静的セマンティクス:TopLevelLexicallyScopedDeclarations

構文指向オペレーション TopLevelLexicallyScopedDeclarationsは引数を取らず、 リスト構文ノード)を返す。それは次の生成規則ごとに定義される:

StatementList : StatementList StatementListItem
  1. declarations1を、TopLevelLexicallyScopedDeclarationsStatementListに対する値とする。
  2. declarations2を、TopLevelLexicallyScopedDeclarationsStatementListItemに対する値とする。
  3. リスト連結declarations1declarations2を返す。
StatementListItem : Statement
  1. 新しい空のリストを返す。
StatementListItem : Declaration
  1. もしDeclaration Declaration : HoistableDeclaration ならば、
    1. 新しい空のリストを返す。
  2. « Declaration » を返す。

8.2.10 静的セマンティクス:TopLevelVarDeclaredNames

構文指向オペレーション TopLevelVarDeclaredNamesは引数を取らず、 文字列のリストを返す。それは次の生成規則ごとに定義される:

StatementList : StatementList StatementListItem
  1. names1を、TopLevelVarDeclaredNamesStatementListに対する値とする。
  2. names2を、TopLevelVarDeclaredNamesStatementListItemに対する値とする。
  3. リスト連結names1names2を返す。
StatementListItem : Declaration
  1. もしDeclaration Declaration : HoistableDeclaration ならば、
    1. BoundNamesHoistableDeclarationに対する値を返す。
  2. 新しい空のリストを返す。
StatementListItem : Statement
  1. もしStatement Statement : LabelledStatement ならば、TopLevelVarDeclaredNamesStatementに対する値を返す。
  2. VarDeclaredNamesStatementに対する値を返す。

関数やスクリプトのトップレベルでは、内部のfunction宣言はvar宣言として扱われる。

LabelledStatement : LabelIdentifier : LabelledItem
  1. TopLevelVarDeclaredNamesLabelledItemに対する値を返す。
LabelledItem : Statement
  1. もしStatement Statement : LabelledStatement ならば、TopLevelVarDeclaredNamesStatementに対する値を返す。
  2. VarDeclaredNamesStatementに対する値を返す。
LabelledItem : FunctionDeclaration
  1. BoundNamesFunctionDeclarationに対する値を返す。

8.2.11 静的セマンティクス:TopLevelVarScopedDeclarations

構文指向オペレーション TopLevelVarScopedDeclarationsは引数を取らず、 リスト構文ノード)を返す。それは次の生成規則ごとに定義される:

StatementList : StatementList StatementListItem
  1. declarations1を、TopLevelVarScopedDeclarationsStatementListに対する値とする。
  2. declarations2を、TopLevelVarScopedDeclarationsStatementListItemに対する値とする。
  3. リスト連結declarations1declarations2を返す。
StatementListItem : Statement
  1. もしStatement Statement : LabelledStatement ならば、TopLevelVarScopedDeclarationsStatementに対する値を返す。
  2. VarScopedDeclarationsStatementに対する値を返す。
StatementListItem : Declaration
  1. もしDeclaration Declaration : HoistableDeclaration ならば、
    1. declarationDeclarationPartHoistableDeclarationに対する値とする。
    2. « declaration » を返す。
  2. 新しい空のリストを返す。
LabelledStatement : LabelIdentifier : LabelledItem
  1. TopLevelVarScopedDeclarationsLabelledItemに対する値を返す。
LabelledItem : Statement
  1. もしStatement Statement : LabelledStatement ならば、TopLevelVarScopedDeclarationsStatementに対する値を返す。
  2. VarScopedDeclarationsStatementに対する値を返す。
LabelledItem : FunctionDeclaration
  1. « FunctionDeclaration » を返す。

8.3 ラベル

8.3.1 静的セマンティクス:ContainsDuplicateLabels

構文指向オペレーション ContainsDuplicateLabelsは引数labelSet文字列のリスト)を取り、ブール値を返す。これは以下の生成規則ごとに定義される:

Statement : VariableStatement EmptyStatement ExpressionStatement ContinueStatement BreakStatement ReturnStatement ThrowStatement DebuggerStatement Block : { } StatementListItem : Declaration
  1. falseを返す。
StatementList : StatementList StatementListItem
  1. hasDuplicatesContainsDuplicateLabelsStatementListlabelSetを引数として適用した結果とする。
  2. もしhasDuplicatestrueなら、trueを返す。
  3. ContainsDuplicateLabelsStatementListItemlabelSetを引数として適用した結果を返す。
IfStatement : if ( Expression ) Statement else Statement
  1. hasDuplicateを、最初のStatementlabelSetを引数として ContainsDuplicateLabels を適用した結果とする。
  2. もしhasDuplicatetrueなら、trueを返す。
  3. 2番目のStatementlabelSetを引数として ContainsDuplicateLabels を適用した結果を返す。
IfStatement : if ( Expression ) Statement
  1. ContainsDuplicateLabelsStatementlabelSetを引数として適用した結果を返す。
DoWhileStatement : do Statement while ( Expression ) ;
  1. ContainsDuplicateLabelsStatementlabelSetを引数として適用した結果を返す。
WhileStatement : while ( Expression ) Statement
  1. ContainsDuplicateLabelsStatementlabelSetを引数として適用した結果を返す。
ForStatement : for ( Expressionopt ; Expressionopt ; Expressionopt ) Statement for ( var VariableDeclarationList ; Expressionopt ; Expressionopt ) Statement for ( LexicalDeclaration Expressionopt ; Expressionopt ) Statement
  1. ContainsDuplicateLabelsStatementlabelSetを引数として適用した結果を返す。
ForInOfStatement : for ( LeftHandSideExpression in Expression ) Statement for ( var ForBinding in Expression ) Statement for ( ForDeclaration in Expression ) Statement for ( LeftHandSideExpression of AssignmentExpression ) Statement for ( var ForBinding of AssignmentExpression ) Statement for ( ForDeclaration of AssignmentExpression ) Statement for await ( LeftHandSideExpression of AssignmentExpression ) Statement for await ( var ForBinding of AssignmentExpression ) Statement for await ( ForDeclaration of AssignmentExpression ) Statement
  1. ContainsDuplicateLabelsStatementlabelSetを引数として適用した結果を返す。

このセクションは付録B.3.5によって拡張されている。

WithStatement : with ( Expression ) Statement
  1. ContainsDuplicateLabelsStatementlabelSetを引数として適用した結果を返す。
SwitchStatement : switch ( Expression ) CaseBlock
  1. ContainsDuplicateLabelsCaseBlocklabelSetを引数として適用した結果を返す。
CaseBlock : { }
  1. falseを返す。
CaseBlock : { CaseClausesopt DefaultClause CaseClausesopt }
  1. 最初のCaseClausesが存在する場合、
    1. 最初のCaseClauseslabelSetを引数として ContainsDuplicateLabels を適用した結果がtrueなら、trueを返す。
  2. DefaultClauselabelSetを引数として ContainsDuplicateLabels を適用した結果がtrueなら、trueを返す。
  3. 2番目のCaseClausesが存在しなければ、falseを返す。
  4. 2番目のCaseClauseslabelSetを引数として ContainsDuplicateLabels を適用した結果を返す。
CaseClauses : CaseClauses CaseClause
  1. hasDuplicatesContainsDuplicateLabelsCaseClauseslabelSetを引数として適用した結果とする。
  2. もしhasDuplicatestrueなら、trueを返す。
  3. ContainsDuplicateLabelsCaseClauselabelSetを引数として適用した結果を返す。
CaseClause : case Expression : StatementListopt
  1. StatementListが存在する場合、 ContainsDuplicateLabelsStatementListlabelSetを引数として適用した結果を返す。
  2. falseを返す。
DefaultClause : default : StatementListopt
  1. StatementListが存在する場合、 ContainsDuplicateLabelsStatementListlabelSetを引数として適用した結果を返す。
  2. falseを返す。
LabelledStatement : LabelIdentifier : LabelledItem
  1. labelLabelIdentifierStringValueとする。
  2. もしlabelSetlabelを含むなら、trueを返す。
  3. newLabelSetlist-concatenationによりlabelSetと« label »の連結とする。
  4. ContainsDuplicateLabelsLabelledItemnewLabelSetを引数として適用した結果を返す。
ラベル付き項目 : 関数宣言
  1. false を返す。
try文 : try ブロック catch節
  1. hasDuplicatesContainsDuplicateLabelsブロック と引数 labelSet を設定する。
  2. hasDuplicatestrue の場合、true を返す。
  3. ContainsDuplicateLabelscatch節 と引数 labelSet を返す。
try文 : try ブロック finally節
  1. hasDuplicatesContainsDuplicateLabelsブロック と引数 labelSet を設定する。
  2. hasDuplicatestrue の場合、true を返す。
  3. ContainsDuplicateLabelsfinally節 と引数 labelSet を返す。
try文 : try ブロック catch節 finally節
  1. ContainsDuplicateLabelsブロック と引数 labelSettrue の場合、true を返す。
  2. ContainsDuplicateLabelscatch節 と引数 labelSettrue の場合、true を返す。
  3. ContainsDuplicateLabelsfinally節 と引数 labelSet を返す。
catch節 : catch ( catchパラメータ ) ブロック
  1. ContainsDuplicateLabelsブロック と引数 labelSet を返す。
関数ステートメントリスト : [空]
  1. false を返す。
クラス静的ブロックステートメントリスト : [空]
  1. false を返す。
モジュール項目リスト : モジュール項目リスト モジュール項目
  1. hasDuplicatesContainsDuplicateLabelsモジュール項目リスト と引数 labelSet を設定する。
  2. hasDuplicatestrue の場合、true を返す。
  3. ContainsDuplicateLabelsモジュール項目 と引数 labelSet を返す。
モジュール項目 : インポート宣言 エクスポート宣言
  1. false を返す。

8.3.2 静的セマンティクス: ContainsUndefinedBreakTarget

構文指向オペレーション ContainsUndefinedBreakTarget は引数 labelSet文字列のリスト)を取り、Boolean を返す。これは以下の生成規則ごとに定義される:

Statement : VariableStatement EmptyStatement ExpressionStatement ContinueStatement ReturnStatement ThrowStatement DebuggerStatement Block : { } StatementListItem : Declaration
  1. false を返す。
StatementList : StatementList StatementListItem
  1. hasUndefinedLabelsContainsUndefinedBreakTarget of StatementList を引数 labelSet で適用した結果を代入する。
  2. もし hasUndefinedLabelstrue なら、true を返す。
  3. ContainsUndefinedBreakTarget of StatementListItem を引数 labelSet で適用した結果を返す。
IfStatement : if ( Expression ) Statement else Statement
  1. hasUndefinedLabels に、最初の StatementlabelSet を渡して ContainsUndefinedBreakTarget を適用した結果を代入する。
  2. もし hasUndefinedLabelstrue なら、true を返す。
  3. 2つ目の StatementlabelSet を渡して ContainsUndefinedBreakTarget を適用した結果を返す。
IfStatement : if ( Expression ) Statement
  1. ContainsUndefinedBreakTargetStatementlabelSet を渡して適用した結果を返す。
DoWhileStatement : do Statement while ( Expression ) ;
  1. ContainsUndefinedBreakTargetStatementlabelSet を渡して適用した結果を返す。
WhileStatement : while ( Expression ) Statement
  1. ContainsUndefinedBreakTargetStatementlabelSet を渡して適用した結果を返す。
ForStatement : for ( Expressionopt ; Expressionopt ; Expressionopt ) Statement for ( var VariableDeclarationList ; Expressionopt ; Expressionopt ) Statement for ( LexicalDeclaration Expressionopt ; Expressionopt ) Statement
  1. ContainsUndefinedBreakTargetStatementlabelSet を渡して適用した結果を返す。
ForInOfStatement : for ( LeftHandSideExpression in Expression ) Statement for ( var ForBinding in Expression ) Statement for ( ForDeclaration in Expression ) Statement for ( LeftHandSideExpression of AssignmentExpression ) Statement for ( var ForBinding of AssignmentExpression ) Statement for ( ForDeclaration of AssignmentExpression ) Statement for await ( LeftHandSideExpression of AssignmentExpression ) Statement for await ( var ForBinding of AssignmentExpression ) Statement for await ( ForDeclaration of AssignmentExpression ) Statement
  1. ContainsUndefinedBreakTargetStatementlabelSet を渡して適用した結果を返す。
補足

本節は付録 B.3.5 により拡張される。

BreakStatement : break ;
  1. false を返す。
BreakStatement : break LabelIdentifier ;
  1. もし labelSetLabelIdentifierStringValue が含まれていなければ、true を返す。
  2. false を返す。
WithStatement : with ( Expression ) Statement
  1. ContainsUndefinedBreakTargetStatementlabelSet を渡して適用した結果を返す。
SwitchStatement : switch ( Expression ) CaseBlock
  1. ContainsUndefinedBreakTargetCaseBlocklabelSet を渡して適用した結果を返す。
CaseBlock : { }
  1. false を返す。
CaseBlock : { CaseClausesopt DefaultClause CaseClausesopt }
  1. 最初の CaseClauses が存在する場合、
    1. もし ContainsUndefinedBreakTarget of 最初の CaseClauseslabelSet を渡して適用した結果が true なら、true を返す。
  2. ContainsUndefinedBreakTarget of DefaultClauselabelSet を渡して適用した結果が true なら、true を返す。
  3. 2つ目の CaseClauses が存在しない場合、false を返す。
  4. ContainsUndefinedBreakTarget of 2つ目の CaseClauseslabelSet を渡して適用した結果を返す。
CaseClauses : CaseClauses CaseClause
  1. hasUndefinedLabelsContainsUndefinedBreakTarget of CaseClauseslabelSet を渡して適用した結果を代入する。
  2. もし hasUndefinedLabelstrue なら、true を返す。
  3. ContainsUndefinedBreakTarget of CaseClauselabelSet を渡して適用した結果を返す。
CaseClause : case Expression : StatementListopt
  1. StatementList が存在する場合、ContainsUndefinedBreakTarget of StatementListlabelSet を渡して適用した結果を返す。
  2. false を返す。
DefaultClause : default : StatementListopt
  1. StatementList が存在する場合、ContainsUndefinedBreakTarget of StatementListlabelSet を渡して適用した結果を返す。
  2. false を返す。
LabelledStatement : LabelIdentifier : LabelledItem
  1. labelLabelIdentifierStringValue を代入する。
  2. newLabelSetlabelSet と « label » のリスト連結を代入する。
  3. ContainsUndefinedBreakTargetLabelledItemnewLabelSet を渡して適用した結果を返す。
LabelledItem : FunctionDeclaration
  1. false を返す。
TryStatement : try Block Catch
  1. hasUndefinedLabelsContainsUndefinedBreakTarget of BlocklabelSet を渡して適用した結果を代入する。
  2. もし hasUndefinedLabelstrue なら、true を返す。
  3. ContainsUndefinedBreakTarget of CatchlabelSet を渡して適用した結果を返す。
TryStatement : try Block Finally
  1. hasUndefinedLabelsContainsUndefinedBreakTarget of BlocklabelSet を渡して適用した結果を代入する。
  2. もし hasUndefinedLabelstrue なら、true を返す。
  3. ContainsUndefinedBreakTarget of FinallylabelSet を渡して適用した結果を返す。
TryStatement : try Block Catch Finally
  1. ContainsUndefinedBreakTarget of BlocklabelSet を渡して適用した結果が true なら、true を返す。
  2. ContainsUndefinedBreakTarget of CatchlabelSet を渡して適用した結果が true なら、true を返す。
  3. ContainsUndefinedBreakTarget of FinallylabelSet を渡して適用した結果を返す。
Catch : catch ( CatchParameter ) Block
  1. ContainsUndefinedBreakTarget of BlocklabelSet を渡して適用した結果を返す。
FunctionStatementList : [empty]
  1. false を返す。
ClassStaticBlockStatementList : [empty]
  1. false を返す。
ModuleItemList : ModuleItemList ModuleItem
  1. hasUndefinedLabelsContainsUndefinedBreakTarget of ModuleItemListlabelSet を渡して適用した結果を代入する。
  2. もし hasUndefinedLabelstrue なら、true を返す。
  3. ContainsUndefinedBreakTarget of ModuleItemlabelSet を渡して適用した結果を返す。
ModuleItem : ImportDeclaration ExportDeclaration
  1. false を返す。

8.3.3 静的セマンティクス: ContainsUndefinedContinueTarget

構文指向オペレーション ContainsUndefinedContinueTarget は引数 iterationSet文字列のリスト)および labelSet文字列のリスト)を取り、Boolean を返す。これは以下の生成規則ごとに定義される:

Statement : VariableStatement EmptyStatement ExpressionStatement BreakStatement ReturnStatement ThrowStatement DebuggerStatement Block : { } StatementListItem : Declaration
  1. false を返す。
Statement : BlockStatement
  1. ContainsUndefinedContinueTargetBlockStatementiterationSet および « » を渡して適用した結果を返す。
BreakableStatement : IterationStatement
  1. newIterationSetiterationSetlabelSet のリスト連結を代入する。
  2. ContainsUndefinedContinueTargetIterationStatementnewIterationSet および « » を渡して適用した結果を返す。
StatementList : StatementList StatementListItem
  1. hasUndefinedLabelsContainsUndefinedContinueTarget of StatementListiterationSet および « » を渡して適用した結果を代入する。
  2. もし hasUndefinedLabelstrue なら、true を返す。
  3. ContainsUndefinedContinueTarget of StatementListItemiterationSet および « » を渡して適用した結果を返す。
IfStatement : if ( Expression ) Statement else Statement
  1. hasUndefinedLabelsContainsUndefinedContinueTarget of 最初の StatementiterationSet および « » を渡して適用した結果を代入する。
  2. もし hasUndefinedLabelstrue なら、true を返す。
  3. 2つ目の StatementiterationSet および « » を渡して ContainsUndefinedContinueTarget を適用した結果を返す。
IfStatement : if ( Expression ) Statement
  1. ContainsUndefinedContinueTargetStatementiterationSet および « » を渡して適用した結果を返す。
DoWhileStatement : do Statement while ( Expression ) ;
  1. ContainsUndefinedContinueTargetStatementiterationSet および « » を渡して適用した結果を返す。
WhileStatement : while ( Expression ) Statement
  1. ContainsUndefinedContinueTargetStatementiterationSet および « » を渡して適用した結果を返す。
ForStatement : for ( Expressionopt ; Expressionopt ; Expressionopt ) Statement for ( var VariableDeclarationList ; Expressionopt ; Expressionopt ) Statement for ( LexicalDeclaration Expressionopt ; Expressionopt ) Statement
  1. ContainsUndefinedContinueTargetStatementiterationSet および « » を渡して適用した結果を返す。
ForInOfStatement : for ( LeftHandSideExpression in Expression ) Statement for ( var ForBinding in Expression ) Statement for ( ForDeclaration in Expression ) Statement for ( LeftHandSideExpression of AssignmentExpression ) Statement for ( var ForBinding of AssignmentExpression ) Statement for ( ForDeclaration of AssignmentExpression ) Statement for await ( LeftHandSideExpression of AssignmentExpression ) Statement for await ( var ForBinding of AssignmentExpression ) Statement for await ( ForDeclaration of AssignmentExpression ) Statement
  1. ContainsUndefinedContinueTargetStatementiterationSet および « » を渡して適用した結果を返す。
補足

本節は付録 B.3.5 により拡張される。

ContinueStatement : continue ;
  1. false を返す。
ContinueStatement : continue LabelIdentifier ;
  1. もし iterationSetLabelIdentifierStringValue が含まれていなければ、true を返す。
  2. false を返す。
WithStatement : with ( Expression ) Statement
  1. ContainsUndefinedContinueTargetStatementiterationSet および « » を渡して適用した結果を返す。
SwitchStatement : switch ( Expression ) CaseBlock
  1. ContainsUndefinedContinueTargetCaseBlockiterationSet および « » を渡して適用した結果を返す。
CaseBlock : { }
  1. false を返す。
CaseBlock : { CaseClausesopt DefaultClause CaseClausesopt }
  1. 最初の CaseClauses が存在する場合、
    1. もし ContainsUndefinedContinueTarget of 最初の CaseClausesiterationSet および « » を渡して適用した結果が true なら、true を返す。
  2. ContainsUndefinedContinueTarget of DefaultClauseiterationSet および « » を渡して適用した結果が true なら、true を返す。
  3. 2つ目の CaseClauses が存在しない場合、false を返す。
  4. ContainsUndefinedContinueTarget of 2つ目の CaseClausesiterationSet および « » を渡して適用した結果を返す。
CaseClauses : CaseClauses CaseClause
  1. hasUndefinedLabelsContainsUndefinedContinueTarget of CaseClausesiterationSet および « » を渡して適用した結果を代入する。
  2. もし hasUndefinedLabelstrue なら、true を返す。
  3. ContainsUndefinedContinueTarget of CaseClauseiterationSet および « » を渡して適用した結果を返す。
CaseClause : case Expression : StatementListopt
  1. StatementList が存在する場合、ContainsUndefinedContinueTarget of StatementListiterationSet および « » を渡して適用した結果を返す。
  2. false を返す。
DefaultClause : default : StatementListopt
  1. StatementList が存在する場合、ContainsUndefinedContinueTarget of StatementListiterationSet および « » を渡して適用した結果を返す。
  2. false を返す。
LabelledStatement : LabelIdentifier : LabelledItem
  1. labelLabelIdentifierStringValue を代入する。
  2. newLabelSetlabelSet と « label » のリスト連結を代入する。
  3. ContainsUndefinedContinueTargetLabelledItemiterationSet および newLabelSet を渡して適用した結果を返す。
LabelledItem : FunctionDeclaration
  1. false を返す。
TryStatement : try Block Catch
  1. hasUndefinedLabelsContainsUndefinedContinueTarget of BlockiterationSet および « » を渡して適用した結果を代入する。
  2. もし hasUndefinedLabelstrue なら、true を返す。
  3. ContainsUndefinedContinueTarget of CatchiterationSet および « » を渡して適用した結果を返す。
TryStatement : try Block Finally
  1. hasUndefinedLabelsContainsUndefinedContinueTarget of BlockiterationSet および « » を渡して適用した結果を代入する。
  2. もし hasUndefinedLabelstrue なら、true を返す。
  3. ContainsUndefinedContinueTarget of FinallyiterationSet および « » を渡して適用した結果を返す。
TryStatement : try Block Catch Finally
  1. ContainsUndefinedContinueTarget of BlockiterationSet および « » を渡して適用した結果が true なら、true を返す。
  2. ContainsUndefinedContinueTarget of CatchiterationSet および « » を渡して適用した結果が true なら、true を返す。
  3. ContainsUndefinedContinueTarget of FinallyiterationSet および « » を渡して適用した結果を返す。
Catch : catch ( CatchParameter ) Block
  1. ContainsUndefinedContinueTarget of BlockiterationSet および « » を渡して適用した結果を返す。
FunctionStatementList : [empty]
  1. false を返す。
ClassStaticBlockStatementList : [empty]
  1. false を返す。
ModuleItemList : ModuleItemList ModuleItem
  1. hasUndefinedLabelsContainsUndefinedContinueTarget of ModuleItemListiterationSet および « » を渡して適用した結果を代入する。
  2. もし hasUndefinedLabelstrue なら、true を返す。
  3. ContainsUndefinedContinueTarget of ModuleItemiterationSet および « » を渡して適用した結果を返す。
ModuleItem : ImportDeclaration ExportDeclaration
  1. false を返す。

8.4 関数名の推論

8.4.1 静的セマンティクス: HasName

構文指向オペレーション HasName は引数を取らず、Boolean を返す。これは以下の生成規則ごとに定義される:

PrimaryExpression : CoverParenthesizedExpressionAndArrowParameterList
  1. exprParenthesizedExpressionCoverParenthesizedExpressionAndArrowParameterList によってカバーされているもの)とする。
  2. IsFunctionDefinition of exprfalse なら、false を返す。
  3. HasName of expr を返す。
FunctionExpression : function ( FormalParameters ) { FunctionBody } GeneratorExpression : function * ( FormalParameters ) { GeneratorBody } AsyncGeneratorExpression : async function * ( FormalParameters ) { AsyncGeneratorBody } AsyncFunctionExpression : async function ( FormalParameters ) { AsyncFunctionBody } ArrowFunction : ArrowParameters => ConciseBody AsyncArrowFunction : async AsyncArrowBindingIdentifier => AsyncConciseBody CoverCallExpressionAndAsyncArrowHead => AsyncConciseBody ClassExpression : class ClassTail
  1. false を返す。
FunctionExpression : function BindingIdentifier ( FormalParameters ) { FunctionBody } GeneratorExpression : function * BindingIdentifier ( FormalParameters ) { GeneratorBody } AsyncGeneratorExpression : async function * BindingIdentifier ( FormalParameters ) { AsyncGeneratorBody } AsyncFunctionExpression : async function BindingIdentifier ( FormalParameters ) { AsyncFunctionBody } ClassExpression : class BindingIdentifier ClassTail
  1. true を返す。

8.4.2 静的セマンティクス: IsFunctionDefinition

構文指向オペレーション IsFunctionDefinition は引数を取らず、Boolean を返す。このオペレーションは、以下の生成規則ごとに定義される:

PrimaryExpression : CoverParenthesizedExpressionAndArrowParameterList
  1. exprParenthesizedExpressionCoverParenthesizedExpressionAndArrowParameterList によりカバーされているもの)とする。
  2. IsFunctionDefinition of expr を返す。
PrimaryExpression : this IdentifierReference Literal ArrayLiteral ObjectLiteral RegularExpressionLiteral TemplateLiteral MemberExpression : MemberExpression [ Expression ] MemberExpression . IdentifierName MemberExpression TemplateLiteral SuperProperty MetaProperty new MemberExpression Arguments MemberExpression . PrivateIdentifier NewExpression : new NewExpression LeftHandSideExpression : CallExpression OptionalExpression UpdateExpression : LeftHandSideExpression ++ LeftHandSideExpression -- ++ UnaryExpression -- UnaryExpression UnaryExpression : delete UnaryExpression void UnaryExpression typeof UnaryExpression + UnaryExpression - UnaryExpression ~ UnaryExpression ! UnaryExpression AwaitExpression ExponentiationExpression : UpdateExpression ** ExponentiationExpression MultiplicativeExpression : MultiplicativeExpression MultiplicativeOperator ExponentiationExpression AdditiveExpression : AdditiveExpression + MultiplicativeExpression AdditiveExpression - MultiplicativeExpression ShiftExpression : ShiftExpression << AdditiveExpression ShiftExpression >> AdditiveExpression ShiftExpression >>> AdditiveExpression RelationalExpression : RelationalExpression < ShiftExpression RelationalExpression > ShiftExpression RelationalExpression <= ShiftExpression RelationalExpression >= ShiftExpression RelationalExpression instanceof ShiftExpression RelationalExpression in ShiftExpression PrivateIdentifier in ShiftExpression EqualityExpression : EqualityExpression == RelationalExpression EqualityExpression != RelationalExpression EqualityExpression === RelationalExpression EqualityExpression !== RelationalExpression BitwiseANDExpression : BitwiseANDExpression & EqualityExpression BitwiseXORExpression : BitwiseXORExpression ^ BitwiseANDExpression BitwiseORExpression : BitwiseORExpression | BitwiseXORExpression LogicalANDExpression : LogicalANDExpression && BitwiseORExpression LogicalORExpression : LogicalORExpression || LogicalANDExpression CoalesceExpression : CoalesceExpressionHead ?? BitwiseORExpression ConditionalExpression : ShortCircuitExpression ? AssignmentExpression : AssignmentExpression AssignmentExpression : YieldExpression LeftHandSideExpression = AssignmentExpression LeftHandSideExpression AssignmentOperator AssignmentExpression LeftHandSideExpression &&= AssignmentExpression LeftHandSideExpression ||= AssignmentExpression LeftHandSideExpression ??= AssignmentExpression Expression : Expression , AssignmentExpression
  1. false を返す。
AssignmentExpression : ArrowFunction AsyncArrowFunction FunctionExpression : function BindingIdentifieropt ( FormalParameters ) { FunctionBody } GeneratorExpression : function * BindingIdentifieropt ( FormalParameters ) { GeneratorBody } AsyncGeneratorExpression : async function * BindingIdentifieropt ( FormalParameters ) { AsyncGeneratorBody } AsyncFunctionExpression : async function BindingIdentifieropt ( FormalParameters ) { AsyncFunctionBody } ClassExpression : class BindingIdentifieropt ClassTail
  1. true を返す。

8.4.3 静的セマンティクス: IsAnonymousFunctionDefinition (expr)

抽象オペレーション IsAnonymousFunctionDefinition は引数 exprAssignmentExpression 構文ノードInitializer 構文ノード、または Expression 構文ノード)を取り、Boolean を返す。このオペレーションは、引数が名前を束縛しない関数定義であるかどうかを判定する。呼び出されたとき、次の手順を実行する:

  1. IsFunctionDefinition of exprfalse なら、false を返す。
  2. hasNameHasName of expr を代入する。
  3. hasNametrue なら、false を返す。
  4. true を返す。

8.4.4 静的セマンティクス: IsIdentifierRef

構文指向オペレーション IsIdentifierRef は引数を取らず、Boolean を返す。これは以下の生成規則ごとに定義される:

PrimaryExpression : IdentifierReference
  1. true を返す。
PrimaryExpression : this Literal ArrayLiteral ObjectLiteral FunctionExpression ClassExpression GeneratorExpression AsyncFunctionExpression AsyncGeneratorExpression RegularExpressionLiteral TemplateLiteral CoverParenthesizedExpressionAndArrowParameterList MemberExpression : MemberExpression [ Expression ] MemberExpression . IdentifierName MemberExpression TemplateLiteral SuperProperty MetaProperty new MemberExpression Arguments MemberExpression . PrivateIdentifier NewExpression : new NewExpression LeftHandSideExpression : CallExpression OptionalExpression
  1. false を返す。

8.4.5 実行時セマンティクス: NamedEvaluation

構文指向オペレーション NamedEvaluation は引数 nameプロパティキー または プライベート名)を取り、正常完了値関数オブジェクトを含む)または突然の完了を返す。これは以下の生成規則ごとに定義される:

PrimaryExpression : CoverParenthesizedExpressionAndArrowParameterList
  1. exprParenthesizedExpressionCoverParenthesizedExpressionAndArrowParameterList によりカバーされているもの)とする。
  2. ? NamedEvaluation of expr に引数 name を渡して返す。
ParenthesizedExpression : ( Expression )
  1. アサート: IsAnonymousFunctionDefinition(Expression) が true であること。
  2. ? NamedEvaluation of Expression に引数 name を渡して返す。
FunctionExpression : function ( FormalParameters ) { FunctionBody }
  1. InstantiateOrdinaryFunctionExpression of FunctionExpression に引数 name を渡して返す。
GeneratorExpression : function * ( FormalParameters ) { GeneratorBody }
  1. InstantiateGeneratorFunctionExpression of GeneratorExpression に引数 name を渡して返す。
AsyncGeneratorExpression : async function * ( FormalParameters ) { AsyncGeneratorBody }
  1. InstantiateAsyncGeneratorFunctionExpression of AsyncGeneratorExpression に引数 name を渡して返す。
AsyncFunctionExpression : async function ( FormalParameters ) { AsyncFunctionBody }
  1. InstantiateAsyncFunctionExpression of AsyncFunctionExpression に引数 name を渡して返す。
ArrowFunction : ArrowParameters => ConciseBody
  1. InstantiateArrowFunctionExpression of ArrowFunction に引数 name を渡して返す。
AsyncArrowFunction : async AsyncArrowBindingIdentifier => AsyncConciseBody CoverCallExpressionAndAsyncArrowHead => AsyncConciseBody
  1. InstantiateAsyncArrowFunctionExpression of AsyncArrowFunction に引数 name を渡して返す。
ClassExpression : class ClassTail
  1. value に ? ClassDefinitionEvaluation of ClassTail に引数 undefinedname を渡して返す。
  2. value.[[SourceText]]ClassExpression にマッチしたソーステキストを設定する。
  3. value を返す。

8.5 含む

8.5.1 静的セマンティクス: Contains

構文指向オペレーション Containsは引数symbol(文法記号)を取り、Booleanを返す。

本仕様において、以下に列挙されていないすべての文法生成規則の選択肢は、暗黙的に次のデフォルトのContains定義を持つ:

  1. この構文ノードの各子ノードchildについて、以下を実行する:
    1. もしchildsymbolのインスタンスであれば、trueを返す。
    2. もしchildが非終端記号のインスタンスであれば、
      1. containedchild Contains symbolの結果とする。
      2. もしcontainedtrueであれば、trueを返す。
  2. falseを返す。
FunctionDeclaration : function BindingIdentifier ( FormalParameters ) { FunctionBody } function ( FormalParameters ) { FunctionBody } FunctionExpression : function BindingIdentifieropt ( FormalParameters ) { FunctionBody } GeneratorDeclaration : function * BindingIdentifier ( FormalParameters ) { GeneratorBody } function * ( FormalParameters ) { GeneratorBody } GeneratorExpression : function * BindingIdentifieropt ( FormalParameters ) { GeneratorBody } AsyncGeneratorDeclaration : async function * BindingIdentifier ( FormalParameters ) { AsyncGeneratorBody } async function * ( FormalParameters ) { AsyncGeneratorBody } AsyncGeneratorExpression : async function * BindingIdentifieropt ( FormalParameters ) { AsyncGeneratorBody } AsyncFunctionDeclaration : async function BindingIdentifier ( FormalParameters ) { AsyncFunctionBody } async function ( FormalParameters ) { AsyncFunctionBody } AsyncFunctionExpression : async function BindingIdentifieropt ( FormalParameters ) { AsyncFunctionBody }
  1. falseを返す。
注 1

サブ構造に依存する静的セマンティクス規則は、一般的に関数定義の内部は調べない。

ClassTail : ClassHeritageopt { ClassBody }
  1. もしsymbolClassBodyであれば、trueを返す。
  2. もしsymbolClassHeritageであれば、
    1. もしClassHeritageが存在すればtrue、そうでなければfalseを返す。
  3. もしClassHeritageが存在すれば、
    1. もしClassHeritage Contains symboltrueであれば、trueを返す。
  4. ComputedPropertyContainsClassBodyと引数symbolで呼び出した結果を返す。
注 2

サブ構造に依存する静的セマンティクス規則は、一般的にクラス本体の内部はPropertyName以外は調べない。

ClassStaticBlock : static { ClassStaticBlockBody }
  1. falseを返す。
注 3

サブ構造に依存する静的セマンティクス規則は、一般的にstatic 初期化ブロックの内部は調べない。

ArrowFunction : ArrowParameters => ConciseBody
  1. もしsymbolNewTargetSuperPropertySuperCallsuper、またはthisのいずれでもなければ、falseを返す。
  2. もしArrowParameters Contains symboltrueであれば、trueを返す。
  3. ConciseBody Contains symbolの結果を返す。
ArrowParameters : CoverParenthesizedExpressionAndArrowParameterList
  1. formalsArrowFormalParametersとし、それは被覆されているCoverParenthesizedExpressionAndArrowParameterListに対応する。
  2. formals Contains symbolの結果を返す。
AsyncArrowFunction : async AsyncArrowBindingIdentifier => AsyncConciseBody
  1. もしsymbolNewTargetSuperPropertySuperCallsuper、またはthisのいずれでもなければ、falseを返す。
  2. AsyncConciseBody Contains symbolの結果を返す。
AsyncArrowFunction : CoverCallExpressionAndAsyncArrowHead => AsyncConciseBody
  1. もしsymbolNewTargetSuperPropertySuperCallsuper、またはthisのいずれでもなければ、falseを返す。
  2. headAsyncArrowHeadとし、それは被覆されているCoverCallExpressionAndAsyncArrowHeadに対応する。
  3. もしhead Contains symboltrueであれば、trueを返す。
  4. AsyncConciseBody Contains symbolの結果を返す。
注 4

ContainsはArrowFunctionまたはAsyncArrowFunction内でnew.targetthis、およびsuperの使用を検出するために利用される。

PropertyDefinition : MethodDefinition
  1. もしsymbolMethodDefinitionであれば、trueを返す。
  2. ComputedPropertyContainsMethodDefinitionと引数symbolで呼び出した結果を返す。
LiteralPropertyName : IdentifierName
  1. falseを返す。
MemberExpression : MemberExpression . IdentifierName
  1. もしMemberExpression Contains symboltrueであれば、trueを返す。
  2. falseを返す。
SuperProperty : super . IdentifierName
  1. もしsymbolReservedWord superであれば、trueを返す。
  2. falseを返す。
CallExpression : CallExpression . IdentifierName
  1. もしCallExpression Contains symboltrueであれば、trueを返す。
  2. falseを返す。
OptionalChain : ?. IdentifierName
  1. falseを返す。
OptionalChain : OptionalChain . IdentifierName
  1. もしOptionalChain Contains symboltrueであれば、trueを返す。
  2. falseを返す。

8.5.2 静的セマンティクス: ComputedPropertyContains

構文指向オペレーション ComputedPropertyContainsは引数symbol(文法記号)を取り、Booleanを返す。このオペレーションは、次の生成規則ごとに定義される:

ClassElementName : PrivateIdentifier PropertyName : LiteralPropertyName
  1. falseを返す。
PropertyName : ComputedPropertyName
  1. ComputedPropertyName Contains symbolの結果を返す。
MethodDefinition : ClassElementName ( UniqueFormalParameters ) { FunctionBody } get ClassElementName ( ) { FunctionBody } set ClassElementName ( PropertySetParameterList ) { FunctionBody }
  1. ComputedPropertyContainsClassElementNameと引数symbolで呼び出した結果を返す。
GeneratorMethod : * ClassElementName ( UniqueFormalParameters ) { GeneratorBody }
  1. ComputedPropertyContainsClassElementNameと引数symbolで呼び出した結果を返す。
AsyncGeneratorMethod : async * ClassElementName ( UniqueFormalParameters ) { AsyncGeneratorBody }
  1. ComputedPropertyContainsClassElementNameと引数symbolで呼び出した結果を返す。
ClassElementList : ClassElementList ClassElement
  1. inListComputedPropertyContainsClassElementListと引数symbolで呼び出した結果とする。
  2. もしinListtrueであれば、trueを返す。
  3. ComputedPropertyContainsClassElementと引数symbolで呼び出した結果を返す。
ClassElement : ClassStaticBlock
  1. falseを返す。
ClassElement : ;
  1. falseを返す。
AsyncMethod : async ClassElementName ( UniqueFormalParameters ) { AsyncFunctionBody }
  1. ComputedPropertyContainsClassElementNameと引数symbolで呼び出した結果を返す。
FieldDefinition : ClassElementName Initializeropt
  1. ComputedPropertyContainsClassElementNameと引数symbolで呼び出した結果を返す。

8.6 その他

これらの操作は、仕様書の複数の箇所で使用されます。

8.6.1 実行時セマンティクス: InstantiateFunctionObject

構文指向操作 InstantiateFunctionObject は、引数 envEnvironment Record )および privateEnvPrivateEnvironment Record または null)を取り、ECMAScript 関数オブジェクト を返します。これは、以下の生成規則ごとに定義されます:

FunctionDeclaration : function BindingIdentifier ( FormalParameters ) { FunctionBody } function ( FormalParameters ) { FunctionBody }
  1. InstantiateOrdinaryFunctionObjectFunctionDeclaration、引数 env および privateEnv で呼び出した結果を返す。
GeneratorDeclaration : function * BindingIdentifier ( FormalParameters ) { GeneratorBody } function * ( FormalParameters ) { GeneratorBody }
  1. InstantiateGeneratorFunctionObjectGeneratorDeclaration、引数 env および privateEnv で呼び出した結果を返す。
AsyncGeneratorDeclaration : async function * BindingIdentifier ( FormalParameters ) { AsyncGeneratorBody } async function * ( FormalParameters ) { AsyncGeneratorBody }
  1. InstantiateAsyncGeneratorFunctionObjectAsyncGeneratorDeclaration、引数 env および privateEnv で呼び出した結果を返す。
AsyncFunctionDeclaration : async function BindingIdentifier ( FormalParameters ) { AsyncFunctionBody } async function ( FormalParameters ) { AsyncFunctionBody }
  1. InstantiateAsyncFunctionObjectAsyncFunctionDeclaration、引数 env および privateEnv で呼び出した結果を返す。

8.6.2 実行時セマンティクス: BindingInitialization

構文指向操作 BindingInitialization は、引数 valueECMAScript 言語値)および environmentEnvironment Record または undefined)を取り、unused を含む正常完了 または 突然の完了 のいずれかを返す。

environmentundefined が渡される場合、 初期化値の代入には PutValue 操作が使用されることを示す。これは var 文や一部の 非厳格関数 の仮引数リストの場合である(10.2.11 を参照)。 これらの場合、レキシカルバインディングが巻き上げられ、初期化子の評価前に事前初期化される。

これは以下の生成規則ごとに定義される:

BindingIdentifier : Identifier
  1. nameStringValueIdentifier の)とする。
  2. InitializeBoundName(name, value, environment) を実行し、その結果を返す(?付き)。
BindingIdentifier : yield
  1. InitializeBoundName("yield", value, environment) を実行し、その結果を返す(?付き)。
BindingIdentifier : await
  1. InitializeBoundName("await", value, environment) を実行し、その結果を返す(?付き)。
BindingPattern : ObjectBindingPattern
  1. RequireObjectCoercible(value) を実行する。
  2. BindingInitialization of ObjectBindingPattern(引数 valueenvironment) を実行し、その結果を返す(?付き)。
BindingPattern : ArrayBindingPattern
  1. iteratorRecord を ? GetIterator(value, sync) とする。
  2. resultCompletion( IteratorBindingInitialization of ArrayBindingPattern (引数 iteratorRecordenvironment)) とする。
  3. iteratorRecord.[[Done]]false の場合、? IteratorClose(iteratorRecord, result) を返す。
  4. result を返す。
ObjectBindingPattern : { }
  1. unused を返す。
ObjectBindingPattern : { BindingPropertyList } { BindingPropertyList , }
  1. PropertyBindingInitialization of BindingPropertyList (引数 valueenvironment)を実行する。
  2. unused を返す。
ObjectBindingPattern : { BindingRestProperty }
  1. excludedNames を新しい空の List とする。
  2. RestBindingInitialization of BindingRestProperty (引数 value, environment, excludedNames) を実行し、その結果を返す(?付き)。
ObjectBindingPattern : { BindingPropertyList , BindingRestProperty }
  1. excludedNames を ? PropertyBindingInitialization of BindingPropertyList (引数 valueenvironment)の結果とする。
  2. RestBindingInitialization of BindingRestProperty (引数 value, environment, excludedNames) を実行し、その結果を返す(?付き)。

8.6.2.1 InitializeBoundName ( name, value, environment )

抽象操作 InitializeBoundName は、引数 name(文字列)、valueECMAScript 言語値)、environmentEnvironment Record または undefined)を取り、unused を含む正常完了 または 突然の完了 のいずれかを返す。 呼び出されたとき、次の手順を実行する:

  1. environmentundefined でない場合、
    1. environment.InitializeBinding(name, value) を実行する。
    2. unused を返す。
  2. それ以外の場合、
    1. lhs を ? ResolveBinding(name) とする。
    2. PutValue(lhs, value) を返す。

8.6.3 実行時セマンティクス: IteratorBindingInitialization

構文指向操作 IteratorBindingInitialization は、iteratorRecordIterator Record )および environmentEnvironment Record または undefined)を引数として取り、 unused を含む正常完了 または 突然の完了 のいずれかを返す。

environmentundefined が渡された場合、それは初期化値の代入に PutValue 操作を使用することを示す。これは 非厳格関数 の仮引数リストの場合であり、この場合、同じ名前の複数パラメータの可能性に対応するため、仮引数バインディングは事前初期化される。

これは以下の生成規則ごとに定義される:

ArrayBindingPattern : [ ]
  1. unused を返す。
ArrayBindingPattern : [ Elision ]
  1. IteratorDestructuringAssignmentEvaluation of Elision(引数 iteratorRecord) を実行し、その結果を返す。
ArrayBindingPattern : [ Elisionopt BindingRestElement ]
  1. Elision が存在する場合、
    1. IteratorDestructuringAssignmentEvaluation of Elision(引数 iteratorRecord) を実行する。
  2. IteratorBindingInitialization of BindingRestElement (引数 iteratorRecord および environment)を実行し、その結果を返す。
ArrayBindingPattern : [ BindingElementList , Elision ]
  1. IteratorBindingInitialization of BindingElementList (引数 iteratorRecord および environment)を実行する。
  2. IteratorDestructuringAssignmentEvaluation of Elision(引数 iteratorRecord) を実行し、その結果を返す。
ArrayBindingPattern : [ BindingElementList , Elisionopt BindingRestElement ]
  1. IteratorBindingInitialization of BindingElementList (引数 iteratorRecord および environment)を実行する。
  2. Elision が存在する場合、
    1. IteratorDestructuringAssignmentEvaluation of Elision(引数 iteratorRecord) を実行する。
  3. IteratorBindingInitialization of BindingRestElement (引数 iteratorRecord および environment)を実行し、その結果を返す。
BindingElementList : BindingElementList , BindingElisionElement
  1. IteratorBindingInitialization of BindingElementList (引数 iteratorRecord および environment)を実行する。
  2. IteratorBindingInitialization of BindingElisionElement (引数 iteratorRecord および environment)を実行し、その結果を返す。
BindingElisionElement : Elision BindingElement
  1. IteratorDestructuringAssignmentEvaluation of Elision(引数 iteratorRecord) を実行する。
  2. IteratorBindingInitialization of BindingElement (引数 iteratorRecord および environment)を実行し、その結果を返す。
SingleNameBinding : BindingIdentifier Initializeropt
  1. bindingIdStringValue of BindingIdentifier とする。
  2. lhs を ? ResolveBinding(bindingId, environment) とする。
  3. vundefined とする。
  4. iteratorRecord.[[Done]]false の場合、
    1. next を ? IteratorStepValue(iteratorRecord) とする。
    2. nextdone でない場合、
      1. vnext を設定する。
  5. Initializer が存在し、 vundefined の場合、
    1. IsAnonymousFunctionDefinition (Initializer) が true の場合、
      1. v に ? NamedEvaluation of Initializer (引数 bindingId )の結果を設定する。
    2. それ以外の場合、
      1. defaultValue を ? Evaluation of Initializer の結果とする。
      2. v に ? GetValue(defaultValue) の結果を設定する。
  6. environmentundefined の場合、 ? PutValue(lhs, v) を返す。
  7. InitializeReferencedBinding(lhs, v) を返す。
BindingElement : BindingPattern Initializeropt
  1. vundefined とする。
  2. iteratorRecord.[[Done]]false の場合、
    1. next を ? IteratorStepValue(iteratorRecord) とする。
    2. nextdone でない場合、
      1. vnext を設定する。
  3. Initializer が存在し、 vundefined の場合、
    1. defaultValue を ? Evaluation of Initializer の結果とする。
    2. v に ? GetValue(defaultValue) の結果を設定する。
  4. BindingInitialization of BindingPattern (引数 v および environment)を実行し、その結果を返す。
BindingRestElement : ... BindingIdentifier
  1. lhs を ? ResolveBinding(StringValue of BindingIdentifier, environment) とする。
  2. A を ! ArrayCreate(0) とする。
  3. n を 0 とする。
  4. 繰り返し、
    1. nextdone とする。
    2. iteratorRecord.[[Done]]false の場合、
      1. next に ? IteratorStepValue(iteratorRecord) を設定する。
    3. nextdone の場合、
      1. environmentundefined なら ? PutValue(lhs, A) を返す。
      2. InitializeReferencedBinding(lhs, A) を返す。
    4. CreateDataPropertyOrThrow(A, ! ToString(𝔽(n)), next) を実行する。
    5. nn + 1 に設定する。
BindingRestElement : ... BindingPattern
  1. A を ! ArrayCreate(0) とする。
  2. n を 0 とする。
  3. 繰り返し、
    1. nextdone とする。
    2. iteratorRecord.[[Done]]false の場合、
      1. next に ? IteratorStepValue(iteratorRecord) を設定する。
    3. nextdone の場合、
      1. BindingInitialization of BindingPattern (引数 A および environment)を実行し、その結果を返す。
    4. CreateDataPropertyOrThrow(A, ! ToString(𝔽(n)), next) を実行する。
    5. nn + 1 に設定する。
FormalParameters : [empty]
  1. unused を返す。
FormalParameters : FormalParameterList , FunctionRestParameter
  1. IteratorBindingInitialization of FormalParameterList (引数 iteratorRecord および environment)を実行する。
  2. IteratorBindingInitialization of FunctionRestParameter (引数 iteratorRecord および environment)を実行し、その結果を返す。
FormalParameterList : FormalParameterList , FormalParameter
  1. IteratorBindingInitialization of FormalParameterList (引数 iteratorRecord および environment)を実行する。
  2. IteratorBindingInitialization of FormalParameter (引数 iteratorRecord および environment)を実行し、その結果を返す。
ArrowParameters : BindingIdentifier
  1. vundefined とする。
  2. Assert: iteratorRecord.[[Done]]false である。
  3. next を ? IteratorStepValue(iteratorRecord) とする。
  4. nextdone でない場合、
    1. vnext を設定する。
  5. BindingInitialization of BindingIdentifier (引数 v および environment)を実行し、その結果を返す。
ArrowParameters : CoverParenthesizedExpressionAndArrowParameterList
  1. formalsArrowFormalParametersCoverParenthesizedExpressionAndArrowParameterList により cover される)とする。
  2. IteratorBindingInitialization of formals(引数 iteratorRecord および environment)を実行し、その結果を返す。
AsyncArrowBindingIdentifier : BindingIdentifier
  1. vundefined とする。
  2. Assert: iteratorRecord.[[Done]]false である。
  3. next を ? IteratorStepValue(iteratorRecord) とする。
  4. nextdone でない場合、
    1. vnext を設定する。
  5. BindingInitialization of BindingIdentifier (引数 v および environment)を実行し、その結果を返す。

8.6.4 静的セマンティクス: AssignmentTargetType

構文指向操作 AssignmentTargetType は引数を取らず、simpleweb-compat、または invalid を返す。これは以下の生成規則ごとに定義される:

IdentifierReference : Identifier
  1. IsStrict(この IdentifierReference) が true であり、かつ StringValue of Identifier"eval" または "arguments" のいずれかである場合、invalid を返す。
  2. simple を返す。
IdentifierReference : yield await CallExpression : CallExpression [ Expression ] CallExpression . IdentifierName CallExpression . PrivateIdentifier MemberExpression : MemberExpression [ Expression ] MemberExpression . IdentifierName SuperProperty MemberExpression . PrivateIdentifier
  1. simple を返す。
PrimaryExpression : CoverParenthesizedExpressionAndArrowParameterList
  1. exprParenthesizedExpressionCoverParenthesizedExpressionAndArrowParameterList により cover されたもの)とする。
  2. exprAssignmentTargetType を返す。
CallExpression : CoverCallExpressionAndAsyncArrowHead CallExpression Arguments
  1. ホスト がウェブブラウザーであるか、または 関数呼び出し代入ターゲットの実行時エラー をサポートしており、 IsStrict(この CallExpression) が false の場合、
    1. web-compat を返す。
  2. invalid を返す。
PrimaryExpression : this Literal ArrayLiteral ObjectLiteral FunctionExpression ClassExpression GeneratorExpression AsyncFunctionExpression AsyncGeneratorExpression RegularExpressionLiteral TemplateLiteral CallExpression : SuperCall ImportCall CallExpression TemplateLiteral NewExpression : new NewExpression MemberExpression : MemberExpression TemplateLiteral new MemberExpression Arguments NewTarget : new . target ImportMeta : import . meta LeftHandSideExpression : OptionalExpression UpdateExpression : LeftHandSideExpression ++ LeftHandSideExpression -- ++ UnaryExpression -- UnaryExpression UnaryExpression : delete UnaryExpression void UnaryExpression typeof UnaryExpression + UnaryExpression - UnaryExpression ~ UnaryExpression ! UnaryExpression AwaitExpression ExponentiationExpression : UpdateExpression ** ExponentiationExpression MultiplicativeExpression : MultiplicativeExpression MultiplicativeOperator ExponentiationExpression AdditiveExpression : AdditiveExpression + MultiplicativeExpression AdditiveExpression - MultiplicativeExpression ShiftExpression : ShiftExpression << AdditiveExpression ShiftExpression >> AdditiveExpression ShiftExpression >>> AdditiveExpression RelationalExpression : RelationalExpression < ShiftExpression RelationalExpression > ShiftExpression RelationalExpression <= ShiftExpression RelationalExpression >= ShiftExpression RelationalExpression instanceof ShiftExpression RelationalExpression in ShiftExpression PrivateIdentifier in ShiftExpression EqualityExpression : EqualityExpression == RelationalExpression EqualityExpression != RelationalExpression EqualityExpression === RelationalExpression EqualityExpression !== RelationalExpression BitwiseANDExpression : BitwiseANDExpression & EqualityExpression BitwiseXORExpression : BitwiseXORExpression ^ BitwiseANDExpression BitwiseORExpression : BitwiseORExpression | BitwiseXORExpression LogicalANDExpression : LogicalANDExpression && BitwiseORExpression LogicalORExpression : LogicalORExpression || LogicalANDExpression CoalesceExpression : CoalesceExpressionHead ?? BitwiseORExpression ConditionalExpression : ShortCircuitExpression ? AssignmentExpression : AssignmentExpression AssignmentExpression : YieldExpression ArrowFunction AsyncArrowFunction LeftHandSideExpression = AssignmentExpression LeftHandSideExpression AssignmentOperator AssignmentExpression LeftHandSideExpression &&= AssignmentExpression LeftHandSideExpression ||= AssignmentExpression LeftHandSideExpression ??= AssignmentExpression Expression : Expression , AssignmentExpression
  1. invalid を返す。

8.6.5 静的セマンティクス: PropName

構文指向操作 PropName は引数を取らず、文字列または empty を返す。これは以下の生成規則ごとに定義される:

PropertyDefinition : IdentifierReference
  1. IdentifierReferenceStringValue を返す。
PropertyDefinition : ... AssignmentExpression
  1. empty を返す。
PropertyDefinition : PropertyName : AssignmentExpression
  1. PropertyNamePropName を返す。
LiteralPropertyName : IdentifierName AttributeKey : IdentifierName
  1. IdentifierNameStringValue を返す。
LiteralPropertyName : StringLiteral AttributeKey : StringLiteral
  1. StringLiteralSV を返す。
LiteralPropertyName : NumericLiteral
  1. nbrNumericLiteralNumericValue とする。
  2. ToString(nbr) を返す。
ComputedPropertyName : [ AssignmentExpression ]
  1. empty を返す。
MethodDefinition : ClassElementName ( UniqueFormalParameters ) { FunctionBody } get ClassElementName ( ) { FunctionBody } set ClassElementName ( PropertySetParameterList ) { FunctionBody }
  1. ClassElementNamePropName を返す。
GeneratorMethod : * ClassElementName ( UniqueFormalParameters ) { GeneratorBody }
  1. ClassElementNamePropName を返す。
AsyncGeneratorMethod : async * ClassElementName ( UniqueFormalParameters ) { AsyncGeneratorBody }
  1. ClassElementNamePropName を返す。
ClassElement : ClassStaticBlock
  1. empty を返す。
ClassElement : ;
  1. empty を返す。
AsyncMethod : async ClassElementName ( UniqueFormalParameters ) { AsyncFunctionBody }
  1. ClassElementNamePropName を返す。
FieldDefinition : ClassElementName Initializeropt
  1. ClassElementNamePropName を返す。
ClassElementName : PrivateIdentifier
  1. empty を返す。

9 実行可能コードと実行コンテキスト

9.1 環境レコード

Environment Record は、ECMAScriptコードの字句的なネスト構造に基づいて、Identifier を特定の変数や関数に関連付けるために使用される仕様タイプです。通常、Environment Record は ECMAScript コードの FunctionDeclarationBlockStatement、または Catch 節のような特定の構文構造に関連付けられています。そのようなコードが評価されるたびに、新しい Environment Record が作成され、そのコードによって生成された識別子バインディングを記録します。

すべての Environment Record には [[OuterEnv]] フィールドがあり、これは null か、外側の Environment Record への参照です。これは Environment Record の値の論理的なネストをモデル化するために使用されます。内側の Environment Record の外側参照は、論理的に内側の Environment Record を取り囲む Environment Record への参照です。外側の Environment Record もまた、自身の外側 Environment Record を持つことがあります。Environment Record は複数の内側 Environment Record の外側環境として機能することもあります。例えば、FunctionDeclaration が2つの入れ子になった FunctionDeclaration を含んでいる場合、各入れ子関数の Environment Record の外側 Environment Record は、囲んでいる関数の現在の評価の Environment Record となります。

Environment Record は純粋に仕様上の仕組みであり、ECMAScript 実装の特定のアーティファクトに対応している必要はありません。ECMAScript プログラムがこれらの値に直接アクセスしたり操作することはできません。

9.1.1 環境レコード型の階層

Environment Records は、Environment Record が抽象クラスとして存在し、3つの具体的なサブクラスを持つ単純なオブジェクト指向の階層として考えることができます:宣言的環境レコードオブジェクト環境レコードグローバル環境レコード関数環境レコードモジュール環境レコードは、宣言的環境レコードのサブクラスです。

Environment Record 抽象クラスは、表16 で定義される抽象仕様メソッドを含みます。これらの抽象メソッドは、各具体的サブクラスごとに異なる具体的アルゴリズムを持ちます。

表16: Environment Records の抽象メソッド
メソッド 目的
HasBinding(N) Environment Record が文字列値 N のバインディングを持つかどうか判定する。持っていれば true、持っていなければ false を返す。
CreateMutableBinding(N, D) Environment Record に新しい未初期化の可変バインディングを作成する。文字列値 N はバインド名のテキスト。ブール値 Dtrue の場合、そのバインディングは後で削除可能。
CreateImmutableBinding(N, S) Environment Record に新しい未初期化の不変バインディングを作成する。文字列値 N はバインド名のテキスト。Strue の場合、初期化後にセットしようとすると常に例外が投げられる(参照する操作の strict mode 設定に関わらず)。
InitializeBinding(N, V) Environment Record に既に存在する未初期化バインディングの値をセットする。文字列値 N はバインド名のテキスト。V はバインディングの値で、ECMAScript 言語型 の値である。
SetMutableBinding(N, V, S) Environment Record に既に存在する可変バインディングの値をセットする。文字列値 N はバインド名のテキスト。V はバインディングの値で、ECMAScript 言語型 の値である。SBoolean フラグ。Strue でバインディングをセットできない場合は TypeError 例外を投げる。
GetBindingValue(N, S) Environment Record から既に存在するバインディングの値を返す。文字列値 N はバインド名のテキスト。Sstrict mode コード からの参照や strict mode 参照セマンティクスを必要とする他の参照を識別するために使う。Strue かつバインディングが存在しない場合は ReferenceError 例外を投げる。バインディングが存在するが未初期化の場合は S の値に関わらず ReferenceError を投げる。
DeleteBinding(N) Environment Record からバインディングを削除する。文字列値 N はバインド名のテキスト。N のバインディングが存在する場合、それを削除して true を返す。存在するが削除できない場合は false を返す。バインディングが存在しない場合は true を返す。
HasThisBinding() Environment Recordthis バインディングを確立するかどうか判定する。確立する場合は true、しない場合は false を返す。
HasSuperBinding() Environment Recordsuper メソッドバインディングを確立するかどうか判定する。確立する場合は true、しない場合は false を返す。true を返す場合、その Environment Record関数環境レコード であることを意味するが、その逆は成り立たない。
WithBaseObject() この Environment Recordwith 文に関連付けられている場合は、その with オブジェクトを返す。それ以外の場合は undefined を返す。

9.1.1.1 宣言的環境レコード

宣言的環境レコードは、変数、定数、let、class、module、import、関数宣言を含むECMAScriptプログラムスコープに関連付けられています。宣言的環境レコードは、そのスコープ内に含まれる宣言によって定義された識別子の集合をバインドします。

9.1.1.1.1 HasBinding ( N )

宣言的環境レコード envRec の HasBinding 具体メソッドは、引数 N(文字列)を取り、ブール値を含む正常完了 を返す。このメソッドは、引数の識別子がこのレコードによってバインドされている識別子の一つかどうかを判定する。呼び出されたとき次の手順を実行する:

  1. もし envRecN のバインディングを持っていれば、true を返す。
  2. false を返す。

9.1.1.1.2 CreateMutableBinding ( N, D )

宣言的環境レコード envRec の CreateMutableBinding 具体メソッドは、引数 N(文字列)と D(ブール値)を取り、unused を含む正常完了 を返す。これは N という名前の新しい未初期化の可変バインディングを作成する。この 環境レコードN のバインディングが既に存在してはいけない。Dtrue の場合、新しいバインディングは削除可能としてマークされる。呼び出されたとき次の手順を実行する:

  1. アサート: envRec は既に N のバインディングを持っていない。
  2. envRecN の可変バインディングを作成し、未初期化であることを記録する。Dtrue なら、作成したバインディングが後続の DeleteBinding 呼び出しにより削除可能であることを記録する。
  3. unused を返す。

9.1.1.1.3 CreateImmutableBinding ( N, S )

宣言的環境レコード envRec の CreateImmutableBinding 具体メソッドは、引数 N(文字列)と S(ブール値)を取り、unused を含む正常完了 を返す。これは N という名前の新しい未初期化の不変バインディングを作成する。この 環境レコードN のバインディングが既に存在してはいけない。Strue の場合、新しいバインディングは strict バインディングとしてマークされる。呼び出されたとき次の手順を実行する:

  1. アサート: envRec は既に N のバインディングを持っていない。
  2. envRecN の不変バインディングを作成し、未初期化であることを記録する。Strue なら、作成したバインディングが strict バインディングであることを記録する。
  3. unused を返す。

9.1.1.1.4 InitializeBinding ( N, V )

宣言的環境レコード envRec の InitializeBinding 具体メソッドは、引数 N(文字列)と VECMAScript 言語値)を取り、unused を含む正常完了 を返す。これは、N という名前の識別子の現在のバインディングの値を V に設定するために使われる。N の未初期化バインディングが既に存在していなければならない。呼び出されたとき次の手順を実行する:

  1. アサート: envRecN の未初期化バインディングを持っていること。
  2. envRecN のバインディング値を V に設定する。
  3. 記録envRecN のバインディングが初期化済みであることを記録する。
  4. unused を返す。

9.1.1.1.5 SetMutableBinding ( N, V, S )

宣言的環境レコード envRec の SetMutableBinding 具体メソッドは、引数 N(文字列)、VECMAScript 言語値)、S(ブール値)を取り、unused を含む正常完了 または throw completion を返す。これは N という名前の識別子の現在のバインディング値を V に変更しようとする。通常 N のバインディングは既に存在するが、まれに存在しない場合もある。不変バインディングの場合、Strue なら TypeError を投げる。呼び出されたとき次の手順を実行する:

  1. もし envRecN のバインディングを持たない場合、
    1. もし Strue なら、ReferenceError 例外を投げる。
    2. envRec.CreateMutableBinding(N, true) を実行する。
    3. envRec.InitializeBinding(N, V) を実行する。
    4. unused を返す。
  2. もし envRecN のバインディングが strict バインディングなら、Strue に設定する。
  3. もし envRecN のバインディングが未初期化なら、
    1. ReferenceError 例外を投げる。
  4. それ以外で、envRecN のバインディングが可変バインディングなら、
    1. その値を V に変更する。
  5. それ以外、
    1. アサート: これは不変バインディングの値を変更しようとしている。
    2. もし Strue なら、TypeError 例外を投げる。
  6. unused を返す。

ステップ1でバインディングが存在しない場合の ECMAScript コード例:

function f() { eval("var x; x = (delete x, 0);"); }

9.1.1.1.6 GetBindingValue ( N, S )

宣言的環境レコード envRec の GetBindingValue 具体メソッドは、引数 N(文字列)、S(ブール値)を取り、ECMAScript 言語値を含む正常完了 または throw completion を返す。これは N という名前のバインディング値を返す。バインディングは存在するが未初期化の場合、S の値に関わらず ReferenceError を投げる。呼び出されたとき次の手順を実行する:

  1. アサート: envRecN のバインディングを持っている。
  2. もし envRecN のバインディングが未初期化なら ReferenceError 例外を投げる。
  3. envRecN に現在バインドされている値を返す。

9.1.1.1.7 DeleteBinding ( N )

宣言的環境レコード envRec の DeleteBinding 具体メソッドは、引数 N(文字列)を取り、ブール値を含む正常完了 を返す。明示的に削除可能と指定されたバインディングだけ削除できる。呼び出されたとき次の手順を実行する:

  1. アサート: envRecN のバインディングを持っている。
  2. もし envRecN のバインディングが削除できない場合、false を返す。
  3. envRec から N のバインディングを削除する。
  4. true を返す。

9.1.1.1.8 HasThisBinding ( )

宣言的環境レコード envRec の HasThisBinding 具体メソッドは引数を取らず、false を返す。呼び出されたとき次の手順を実行する:

  1. false を返す。

通常の 宣言的環境レコード(すなわち 関数環境レコード でも モジュール環境レコード でもないもの)は this バインディングを提供しません。

9.1.1.1.9 HasSuperBinding ( )

宣言的環境レコード envRec の HasSuperBinding 具体メソッドは引数を取らず、false を返す。呼び出されたとき次の手順を実行する:

  1. false を返す。

通常の 宣言的環境レコード(すなわち 関数環境レコード でも モジュール環境レコード でもないもの)は super バインディングを提供しません。

9.1.1.1.10 WithBaseObject ( )

宣言的環境レコード envRec の WithBaseObject 具体メソッドは引数を取らず、undefined を返す。呼び出されたとき次の手順を実行する:

  1. undefined を返す。

9.1.1.2 オブジェクト環境レコード

オブジェクト環境レコードは、自身のバインディングオブジェクトと呼ばれるオブジェクトに関連付けられています。オブジェクト環境レコードは、バインディングオブジェクトのプロパティ名と直接対応する文字列識別子名の集合をバインドします。プロパティキーIdentifierName形式の文字列でない場合は、バインドされる識別子集合に含まれません。自身のプロパティも継承プロパティも、[[Enumerable]]属性の設定に関係なく、その集合に含まれます。オブジェクトにプロパティが動的に追加・削除できるため、オブジェクト環境レコードがバインドする識別子の集合は、プロパティの追加・削除操作の副作用として変更される可能性があります。このような副作用で作成されたバインディングは、対応するプロパティのWritable属性がfalseであっても可変バインディングとみなされます。オブジェクト環境レコードには不変バインディングは存在しません。

with文(14.11)のために作成されるオブジェクト環境レコードは、バインディングオブジェクトを関数呼び出し時に暗黙のthis値として提供できます。この機能はBoolean型の[[IsWithEnvironment]]フィールドで制御されます。

オブジェクト環境レコードは、表17に示す追加の状態フィールドを持ちます。

表17: オブジェクト環境レコードの追加フィールド
フィールド名 意味
[[BindingObject]] オブジェクト この環境レコードのバインディングオブジェクト。
[[IsWithEnvironment]] ブール値 この環境レコードwith文のために作成されたかどうかを示す。

9.1.1.2.1 HasBinding ( N )

オブジェクト環境レコード envRec の HasBinding 具体メソッドは、引数 N(文字列)を取り、ブール値を含む正常完了またはthrow completionを返す。関連付けられたバインディングオブジェクトがNという名前のプロパティを持つかどうかを判定する。呼び出されたとき次の手順を実行する:

  1. bindingObjectenvRec.[[BindingObject]]とする。
  2. foundBindingを ? HasProperty(bindingObject, N)とする。
  3. foundBindingfalseなら、falseを返す。
  4. envRec.[[IsWithEnvironment]]falseなら、trueを返す。
  5. unscopablesを ? Get(bindingObject, %Symbol.unscopables%)とする。
  6. unscopablesオブジェクトの場合、
    1. blockedToBoolean(? Get(unscopables, N))とする。
    2. blockedtrueなら、falseを返す。
  7. trueを返す。

9.1.1.2.2 CreateMutableBinding ( N, D )

オブジェクト環境レコード envRec の CreateMutableBinding 具体メソッドは、引数 N(文字列)、D(ブール値)を取り、unused を含む正常完了またはthrow completionを返す。環境レコードに関連付けられたバインディングオブジェクトにNという名前のプロパティを作成し、その値をundefinedに初期化する。Dtrueなら、新しいプロパティの[[Configurable]]属性はtrue、そうでなければfalseに設定される。呼び出されたとき次の手順を実行する:

  1. bindingObjectenvRec.[[BindingObject]]とする。
  2. DefinePropertyOrThrow(bindingObject, N, PropertyDescriptor { [[Value]]: undefined, [[Writable]]: true, [[Enumerable]]: true, [[Configurable]]: D })を実行する。
  3. unusedを返す。

通常envRecNのバインディングを持っていませんが、持っている場合は、DefinePropertyOrThrowのセマンティクスにより既存のバインディングが置き換えられたりシャドウされたり、abrupt completionが返されることがあります。

9.1.1.2.3 CreateImmutableBinding ( N, S )

オブジェクト環境レコードの CreateImmutableBinding 具体メソッドは本仕様内で使用されません。

9.1.1.2.4 InitializeBinding ( N, V )

オブジェクト環境レコード envRec の InitializeBinding 具体メソッドは、引数 N(文字列)、VECMAScript 言語値)を取り、unused を含む正常完了またはthrow completionを返す。これは、Nという名前の識別子の現在のバインディング値をVに設定するために使われる。呼び出されたとき次の手順を実行する:

  1. envRec.SetMutableBinding(N, V, false)を実行する。
  2. unusedを返す。

本仕様では、オブジェクト環境レコードに対する CreateMutableBinding のすべての使用は、同じ名前で直後に InitializeBinding を呼び出します。そのため、この仕様ではオブジェクト環境レコードにおけるバインディングの初期化状態を明示的に追跡しません。

9.1.1.2.5 SetMutableBinding ( N, V, S )

オブジェクト環境レコード envRec の SetMutableBinding 具体メソッドは、引数 N(文字列)、VECMAScript 言語値)、S(ブール値)を取り、unused を含む正常完了またはthrow completionを返す。環境レコードに関連付けられたバインディングオブジェクトのNという名前のプロパティの値をVにセットしようとする。プロパティNは通常既に存在するが、存在しない場合や現在書き込み不可の場合、エラー処理はSで決まる。呼び出されたとき次の手順を実行する:

  1. bindingObjectenvRec.[[BindingObject]]とする。
  2. stillExistsを ? HasProperty(bindingObject, N)とする。
  3. stillExistsfalseかつStrueなら、ReferenceError例外を投げる。
  4. Set(bindingObject, N, V, S)を実行する。
  5. unusedを返す。

9.1.1.2.6 GetBindingValue ( N, S )

オブジェクト環境レコード envRec の GetBindingValue 具体メソッドは、引数 N(文字列)、S(ブール値)を取り、ECMAScript 言語値を含む正常完了またはthrow completionを返す。関連付けられたバインディングオブジェクトのNという名前のプロパティの値を返す。このプロパティは通常既に存在するが、存在しない場合の挙動はSによる。呼び出されたとき次の手順を実行する:

  1. bindingObjectenvRec.[[BindingObject]]とする。
  2. valueを ? HasProperty(bindingObject, N)とする。
  3. valuefalseの場合、
    1. Sfalseならundefinedを返し、そうでなければReferenceError例外を投げる。
  4. Get(bindingObject, N)を返す。

9.1.1.2.7 DeleteBinding ( N )

オブジェクト環境レコード envRec の DeleteBinding 具体メソッドは、引数 N(文字列)を取り、ブール値を含む正常完了またはthrow completionを返す。環境オブジェクトの[[Configurable]]属性がtrueであるプロパティに対応するバインディングだけを削除できる。呼び出されたとき次の手順を実行する:

  1. bindingObjectenvRec.[[BindingObject]]とする。
  2. bindingObject.[[Delete]](N)を返す。

9.1.1.2.8 HasThisBinding ( )

オブジェクト環境レコード envRec の HasThisBinding 具体メソッドは引数を取らず、falseを返す。呼び出されたとき次の手順を実行する:

  1. falseを返す。

オブジェクト環境レコードthisバインディングを提供しません。

9.1.1.2.9 HasSuperBinding ( )

オブジェクト環境レコード envRec の HasSuperBinding 具体メソッドは引数を取らず、falseを返す。呼び出されたとき次の手順を実行する:

  1. falseを返す。

オブジェクト環境レコードsuperバインディングを提供しません。

9.1.1.2.10 WithBaseObject ( )

オブジェクト環境レコード envRec の WithBaseObject 具体メソッドは引数を取らず、オブジェクトまたはundefinedを返す。呼び出されたとき次の手順を実行する:

  1. envRec.[[IsWithEnvironment]]trueなら、envRec.[[BindingObject]]を返す。
  2. それ以外の場合、undefinedを返す。

9.1.1.3 関数環境レコード

関数環境レコードは、関数のトップレベルスコープを表すために使われる宣言的環境レコードであり、関数がArrowFunctionでない場合はthisバインディングを提供します。関数がArrowFunctionでなく、かつsuperを参照する場合、その関数環境レコードは関数内からsuperメソッド呼び出しを行うための状態も保持します。

関数環境レコードは表18に示す追加の状態フィールドを持ちます。

表18: 関数環境レコードの追加フィールド
フィールド名 意味
[[ThisValue]] ECMAScript 言語値 この関数呼び出しで使われるthis値。
[[ThisBindingStatus]] lexicalinitialized、またはuninitialized 値がlexicalの場合は、これはArrowFunctionであり、ローカルのthis値を持ちません。
[[FunctionObject]] ECMAScript 関数オブジェクト この環境レコードが作成された原因となった関数オブジェクト
[[NewTarget]] コンストラクタまたはundefined この環境レコード[[Construct]]内部メソッドで作成された場合、[[NewTarget]][[Construct]]newTargetパラメータの値。それ以外の場合はundefined

関数環境レコードは、宣言的環境レコード表16にあるすべてのメソッドをサポートし、HasThisBinding及びHasSuperBinding以外は同じ仕様を共有します。加えて、関数環境レコードは表19に挙げるメソッドもサポートします。

表19: 関数環境レコードの追加メソッド
メソッド 目的
GetThisBinding() この環境レコードthisバインディングの値を返す。thisバインディングが初期化されていない場合はReferenceErrorを投げる。

9.1.1.3.1 BindThisValue ( envRec, V )

抽象操作 BindThisValue は、引数 envRec関数環境レコード)、 VECMAScript 言語値)を取り、 unused を含む正常完了 またはthrow completionを返す。これはenvRec.[[ThisValue]]を設定し、初期化済みであることを記録する。呼び出されたとき次の手順を実行する:

  1. アサート: envRec.[[ThisBindingStatus]]lexicalでないこと。
  2. envRec.[[ThisBindingStatus]]initializedなら、ReferenceError例外を投げる。
  3. envRec.[[ThisValue]]Vを設定する。
  4. envRec.[[ThisBindingStatus]]initializedを設定する。
  5. unusedを返す。

9.1.1.3.2 HasThisBinding ( )

関数環境レコード envRec の HasThisBinding 具体メソッドは引数を取らず、ブール値を返す。呼び出されたとき次の手順を実行する:

  1. envRec.[[ThisBindingStatus]]lexicalならfalseを返し、それ以外ならtrueを返す。

9.1.1.3.3 HasSuperBinding ( )

関数環境レコード envRec の HasSuperBinding 具体メソッドは引数を取らず、ブール値を返す。呼び出されたとき次の手順を実行する:

  1. envRec.[[ThisBindingStatus]]lexicalならfalseを返す。
  2. envRec.[[FunctionObject]].[[HomeObject]]undefinedならfalseを返し、それ以外ならtrueを返す。

9.1.1.3.4 GetThisBinding ( )

関数環境レコード envRec の GetThisBinding 具体メソッドは引数を取らず、ECMAScript 言語値を含む正常完了またはthrow completionを返す。呼び出されたとき次の手順を実行する:

  1. アサート: envRec.[[ThisBindingStatus]]lexicalでないこと。
  2. envRec.[[ThisBindingStatus]]uninitializedなら、ReferenceError例外を投げる。
  3. envRec.[[ThisValue]]を返す。

9.1.1.3.5 GetSuperBase ( envRec )

抽象操作 GetSuperBase は、引数 envRec関数環境レコード)を取り、オブジェクト、null、またはundefinedを返す。これはenvRecにバインドされたsuperプロパティアクセスの基底となるオブジェクトを返す。値がundefinedの場合、そのようなアクセスは実行時エラーとなる。呼び出されたとき次の手順を実行する:

  1. homeenvRec.[[FunctionObject]].[[HomeObject]]とする。
  2. homeundefinedならundefinedを返す。
  3. アサート: home通常のオブジェクトであること。
  4. home.[[GetPrototypeOf]]()を返す。

9.1.1.4 グローバル環境レコード

グローバル環境レコードは、共通のrealmで処理されるすべてのECMAScript Script要素が共有する最も外側のスコープを表現するために使われます。グローバル環境レコードは、組み込みグローバル(19)、グローバルオブジェクトのプロパティ、そしてScript内で発生するすべてのトップレベル宣言(8.2.98.2.11)のバインディングを提供します。

グローバル環境レコードは論理的には単一のレコードですが、オブジェクト環境レコード宣言的環境レコードをカプセル化した複合体として仕様化されています。オブジェクト環境レコードは、対応するRealm Recordグローバルオブジェクトを基底オブジェクトとします。このグローバルオブジェクトは、グローバル環境レコードのGetThisBinding具体メソッドが返す値です。グローバル環境レコードのオブジェクト環境レコードコンポーネントは、すべての組み込みグローバル(19)と、グローバルコード内のFunctionDeclarationGeneratorDeclarationAsyncFunctionDeclarationAsyncGeneratorDeclarationVariableStatementで導入されたすべてのバインディングを含みます。それ以外のグローバルコードにおけるECMAScript宣言のバインディングは、グローバル環境レコードの宣言的環境レコードコンポーネントに含まれます。

グローバルオブジェクト上に直接プロパティが作成される場合もあります。そのため、グローバル環境レコードのオブジェクト環境レコードコンポーネントには、FunctionDeclarationGeneratorDeclarationAsyncFunctionDeclarationAsyncGeneratorDeclarationVariableDeclaration宣言によって明示的に作成されたバインディングと、グローバルオブジェクトのプロパティとして暗黙的に作成されたバインディングの両方が含まれることがあります。どのバインディングが宣言によって明示的に作成されたかを識別するため、グローバル環境レコードはCreateGlobalVarBindingおよびCreateGlobalFunctionBinding抽象操作でバインドされた名前のリストを保持します。

グローバル環境レコードは、表20に示す追加フィールドと、表21に示す追加メソッドを持ちます。

表20: グローバル環境レコードの追加フィールド
フィールド名 意味
[[ObjectRecord]] オブジェクト環境レコード バインディングオブジェクトはグローバルオブジェクト。関連するrealmのグローバルコード内の組み込みバインディング、FunctionDeclarationGeneratorDeclarationAsyncFunctionDeclarationAsyncGeneratorDeclarationVariableDeclarationのバインディングが含まれる。
[[GlobalThisValue]] オブジェクト グローバルスコープにおけるthisの値。ホストは任意のECMAScriptオブジェクト値を提供できる。
[[DeclarativeRecord]] 宣言的環境レコード 関連するrealmコードのすべての宣言のバインディング(ただしFunctionDeclarationGeneratorDeclarationAsyncFunctionDeclarationAsyncGeneratorDeclarationVariableDeclarationのバインディングは除く)を含む。
表21: グローバル環境レコードの追加メソッド
メソッド 目的
GetThisBinding() この環境レコードthisバインディングの値を返す。

9.1.1.4.1 HasBinding ( N )

グローバル環境レコード envRec の HasBinding 具体メソッドは、引数 N(文字列)を取り、ブール値を含む正常完了またはthrow completionを返す。このメソッドは、引数の識別子がこのレコードによってバインドされている識別子の一つかどうかを判定する。呼び出されたとき次の手順を実行する:

  1. DclRecenvRec.[[DeclarativeRecord]]とする。
  2. DclRec.HasBinding(N)がtrueなら、trueを返す。
  3. ObjRecenvRec.[[ObjectRecord]]とする。
  4. ObjRec.HasBinding(N)を返す。

9.1.1.4.2 CreateMutableBinding ( N, D )

グローバル環境レコード envRec の CreateMutableBinding 具体メソッドは、引数 N(文字列)と D(ブール値)を取り、unused を含む正常完了またはthrow completionを返す。これは N という名前の新しい未初期化の可変バインディングを作成する。バインディングは関連するDeclarativeRecordに作成される。DeclarativeRecordに N のバインディングが既に存在してはいけない。Dtrue の場合、新しいバインディングは削除可能としてマークされる。呼び出されたとき次の手順を実行する:

  1. DclRecenvRec.[[DeclarativeRecord]]とする。
  2. DclRec.HasBinding(N)がtrueなら、TypeError例外を投げる。
  3. DclRec.CreateMutableBinding(N, D)を返す。

9.1.1.4.3 CreateImmutableBinding ( N, S )

グローバル環境レコード envRec の CreateImmutableBinding 具体メソッドは、引数 N(文字列)と S(ブール値)を取り、unused を含む正常完了またはthrow completionを返す。これは N という名前の新しい未初期化の不変バインディングを作成する。この環境レコードNのバインディングが既に存在してはいけない。Strueのとき新しいバインディングはstrictバインディングとしてマークされる。呼び出されたとき次の手順を実行する:

  1. DclRecenvRec.[[DeclarativeRecord]]とする。
  2. DclRec.HasBinding(N)がtrueなら、TypeError例外を投げる。
  3. DclRec.CreateImmutableBinding(N, S)を返す。

9.1.1.4.4 InitializeBinding ( N, V )

グローバル環境レコード envRec の InitializeBinding 具体メソッドは、引数 N(文字列)、VECMAScript 言語値)を取り、unused を含む正常完了またはthrow completionを返す。これは、Nという名前の識別子の現在のバインディング値をVに設定するために使われる。Nの未初期化バインディングが既に存在していなければならない。呼び出されたとき次の手順を実行する:

  1. DclRecenvRec.[[DeclarativeRecord]]とする。
  2. DclRec.HasBinding(N)がtrueなら、
    1. DclRec.InitializeBinding(N, V)を返す。
  3. アサート:バインディングが存在する場合、それはオブジェクト環境レコードに存在しなければならない。
  4. ObjRecenvRec.[[ObjectRecord]]とする。
  5. ObjRec.InitializeBinding(N, V)を返す。

9.1.1.4.5 SetMutableBinding ( N, V, S )

グローバル環境レコード envRec の SetMutableBinding 具体メソッドは、引数 N(文字列)、VECMAScript 言語値)、S(ブール値)を取り、unused を含む正常完了またはthrow completionを返す。これは N という名前の現在のバインディング値をVに変更しようとする。不変バインディングでStrueならTypeErrorが投げられる。プロパティNは通常既に存在するが、存在しない場合や現在書き込み不可の場合、エラー処理はSによる。呼び出されたとき次の手順を実行する:

  1. DclRecenvRec.[[DeclarativeRecord]]とする。
  2. DclRec.HasBinding(N)がtrueなら、
    1. DclRec.SetMutableBinding(N, V, S)を返す。
  3. ObjRecenvRec.[[ObjectRecord]]とする。
  4. ObjRec.SetMutableBinding(N, V, S)を返す。

9.1.1.4.6 GetBindingValue ( N, S )

グローバル環境レコード envRec の GetBindingValue 具体メソッドは、引数N(文字列)、S(ブール値)を取り、ECMAScript 言語値を含む正常完了またはthrow completionを返す。これは、Nという名前のバインドされた識別子の値を返す。バインディングが未初期化の場合はReferenceErrorを投げる。Nという名前のプロパティは通常存在するが、存在しない場合や現在書き込み不可の場合、エラー処理はSによって決まる。呼び出されたとき次の手順を実行する:

  1. DclRecenvRec.[[DeclarativeRecord]]とする。
  2. DclRec.HasBinding(N)がtrueなら、
    1. DclRec.GetBindingValue(N, S)を返す。
  3. ObjRecenvRec.[[ObjectRecord]]とする。
  4. ObjRec.GetBindingValue(N, S)を返す。

9.1.1.4.7 DeleteBinding ( N )

グローバル環境レコード envRec の DeleteBinding 具体メソッドは、引数N(文字列)を取り、ブール値を含む正常完了またはthrow completionを返す。明示的に削除可能と指定されたバインディングだけ削除できる。呼び出されたとき次の手順を実行する:

  1. DclRecenvRec.[[DeclarativeRecord]]とする。
  2. DclRec.HasBinding(N)がtrueなら、
    1. DclRec.DeleteBinding(N)を返す。
  3. ObjRecenvRec.[[ObjectRecord]]とする。
  4. globalObjectObjRec.[[BindingObject]]とする。
  5. existingPropを? HasOwnProperty(globalObject, N)とする。
  6. existingProptrueなら、
    1. ObjRec.DeleteBinding(N)を返す。
  7. trueを返す。

9.1.1.4.8 HasThisBinding ( )

グローバル環境レコード envRec の HasThisBinding 具体メソッドは引数を取らず、trueを返す。呼び出されたとき次の手順を実行する:

  1. trueを返す。

グローバル環境レコードは常にthisバインディングを提供します。

9.1.1.4.9 HasSuperBinding ( )

グローバル環境レコード envRec の HasSuperBinding 具体メソッドは引数を取らず、falseを返す。呼び出されたとき次の手順を実行する:

  1. falseを返す。

グローバル環境レコードsuperバインディングを提供しません。

9.1.1.4.10 WithBaseObject ( )

グローバル環境レコード envRec の WithBaseObject 具体メソッドは引数を取らず、undefinedを返す。呼び出されたとき次の手順を実行する:

  1. undefinedを返す。

9.1.1.4.11 GetThisBinding ( )

グローバル環境レコード envRec の GetThisBinding 具体メソッドは引数を取らず、オブジェクトを含む正常完了を返す。呼び出されたとき次の手順を実行する:

  1. envRec.[[GlobalThisValue]]を返す。

9.1.1.4.12 HasLexicalDeclaration ( envRec, N )

抽象操作 HasLexicalDeclaration は、引数envRecグローバル環境レコード)、N(文字列)を取り、ブール値を返す。これは、引数の識別子がLexicalDeclarationClassDeclarationなどレキシカル宣言で作成されたバインディングをenvRecに持つかどうかを判定する。呼び出されたとき次の手順を実行する:

  1. DclRecenvRec.[[DeclarativeRecord]]とする。
  2. DclRec.HasBinding(N)を返す。

9.1.1.4.13 HasRestrictedGlobalProperty ( envRec, N )

抽象操作 HasRestrictedGlobalProperty は、引数envRecグローバル環境レコード)、N(文字列)を取り、ブール値を含む正常完了またはthrow completionを返す。これは、引数の識別子が、グローバルレキシカルバインディングでシャドウされてはならないグローバルオブジェクトのプロパティ名かどうかを判定する。呼び出されたとき次の手順を実行する:

  1. ObjRecenvRec.[[ObjectRecord]]とする。
  2. globalObjectObjRec.[[BindingObject]]とする。
  3. existingPropを? globalObject.[[GetOwnProperty]](N)とする。
  4. existingPropundefinedなら、falseを返す。
  5. existingProp.[[Configurable]]trueなら、falseを返す。
  6. trueを返す。

グローバルオブジェクト上には、varやfunction宣言を使わずに直接作成されたプロパティが存在する場合がある。グローバルレキシカルバインディングは、グローバルオブジェクトのnon-configurableなプロパティと同じ名前では作成できない。グローバルプロパティ"undefined"はこのようなプロパティの一例である。

9.1.1.4.14 CanDeclareGlobalVar ( envRec, N )

抽象操作 CanDeclareGlobalVar は、引数 envRecグローバル環境レコード)、N(文字列)を取り、ブール値を含む正常完了またはthrow completionを返す。これは、同じ引数NCreateGlobalVarBindingを呼び出した場合に成功するかどうかを判定する。冗長なvar宣言や、既存のグローバルオブジェクトプロパティへのvar宣言は許可される。呼び出されたとき次の手順を実行する:

  1. ObjRecenvRec.[[ObjectRecord]]とする。
  2. globalObjectObjRec.[[BindingObject]]とする。
  3. hasPropertyを? HasOwnProperty(globalObject, N)とする。
  4. hasPropertytrueなら、trueを返す。
  5. IsExtensible(globalObject)を返す。

9.1.1.4.15 CanDeclareGlobalFunction ( envRec, N )

抽象操作 CanDeclareGlobalFunction は、引数 envRecグローバル環境レコード)、N(文字列)を取り、ブール値を含む正常完了またはthrow completionを返す。これは、同じ引数NCreateGlobalFunctionBindingを呼び出した場合に成功するかどうかを判定する。呼び出されたとき次の手順を実行する:

  1. ObjRecenvRec.[[ObjectRecord]]とする。
  2. globalObjectObjRec.[[BindingObject]]とする。
  3. existingPropを? globalObject.[[GetOwnProperty]](N)とする。
  4. existingPropundefinedなら、? IsExtensible(globalObject)を返す。
  5. existingProp.[[Configurable]]trueなら、trueを返す。
  6. IsDataDescriptor(existingProp)がtrueかつexistingPropの属性値が{ [[Writable]]: true, [[Enumerable]]: true }であれば、trueを返す。
  7. falseを返す。

9.1.1.4.16 CreateGlobalVarBinding ( envRec, N, D )

抽象操作 CreateGlobalVarBinding は、引数 envRecグローバル環境レコード)、N(文字列)、D(ブール値)を取り、unused を含む正常完了またはthrow completionを返す。これは、関連するオブジェクト環境レコードに可変バインディングを作成し初期化する。バインディングがすでに存在する場合、それは再利用され、初期化済みと見なされる。呼び出されたとき次の手順を実行する:

  1. ObjRecenvRec.[[ObjectRecord]]とする。
  2. globalObjectObjRec.[[BindingObject]]とする。
  3. hasPropertyを? HasOwnProperty(globalObject, N)とする。
  4. extensibleを? IsExtensible(globalObject)とする。
  5. hasPropertyfalseかつextensibletrueなら、
    1. ObjRec.CreateMutableBinding(N, D)を実行する。
    2. ObjRec.InitializeBinding(N, undefined)を実行する。
  6. unusedを返す。

9.1.1.4.17 CreateGlobalFunctionBinding ( envRec, N, V, D )

抽象操作 CreateGlobalFunctionBinding は、引数 envRecグローバル環境レコード)、N(文字列)、VECMAScript 言語値)、D(ブール値)を取り、unused を含む正常完了またはthrow completionを返す。これは関連するオブジェクト環境レコードに可変バインディングを作成し初期化する。バインディングがすでに存在する場合は置き換えられる。呼び出されたとき次の手順を実行する:

  1. ObjRecenvRec.[[ObjectRecord]]とする。
  2. globalObjectObjRec.[[BindingObject]]とする。
  3. existingPropを? globalObject.[[GetOwnProperty]](N)とする。
  4. existingPropundefinedまたはexistingProp.[[Configurable]]trueなら、
    1. descをPropertyDescriptor { [[Value]]: V, [[Writable]]: true, [[Enumerable]]: true, [[Configurable]]: D }とする。
  5. それ以外の場合、
    1. descをPropertyDescriptor { [[Value]]: V }とする。
  6. DefinePropertyOrThrow(globalObject, N, desc)を実行する。
  7. Set(globalObject, N, V, false)を実行する。
  8. unusedを返す。

グローバル関数宣言は常にグローバルオブジェクトの独自プロパティとして表現される。可能な場合は、既存の独自プロパティは標準的な属性値セットに再設定される。ステップ7はInitializeBinding具体メソッドを呼ぶのと同等であり、globalObjectがProxyの場合は同じProxyトラップの呼び出しシーケンスを生成する。

9.1.1.5 モジュール環境レコード

モジュール環境レコードは、宣言的環境レコードであり、ECMAScript Moduleの外側スコープを表現するために使用されます。通常の可変バインディングと不変バインディングに加えて、モジュール環境レコードは不変のインポートバインディングも提供します。インポートバインディングは、他の環境レコードに存在するターゲットバインディングへの間接的なアクセスを提供するバインディングです。

モジュール環境レコードは、宣言的環境レコード表16に記載されているすべてのメソッドをサポートし、それらのメソッドの仕様は GetBindingValue, DeleteBinding, HasThisBinding, GetThisBinding を除き同一です。さらに、モジュール環境レコードは表22に挙げるメソッドもサポートします。

表22: モジュール環境レコードの追加メソッド
メソッド 目的
GetThisBinding() この環境レコードthisバインディングの値を返す。

9.1.1.5.1 GetBindingValue ( N, S )

モジュール環境レコード envRec の GetBindingValue 具体メソッドは、引数N(文字列)、S(ブール値)を取り、ECMAScript 言語値を含む正常完了またはthrow completionを返す。これは、Nという名前のバインドされた識別子の値を返す。ただし、バインディングが間接バインディングである場合はターゲットバインディングの値を返す。バインディングが未初期化の場合はReferenceErrorを投げる。呼び出されたとき次の手順を実行する:

  1. アサートStrueである。
  2. アサートenvRecNのバインディングを持っている。
  3. もしNのバインディングが間接バインディングなら、
    1. このNのバインディングが作成されたときに提供された間接値MおよびN2を取得する。
    2. targetEnvM.[[Environment]]とする。
    3. targetEnvemptyなら、ReferenceError例外を投げる。
    4. targetEnv.GetBindingValue(N2, true)を返す。
  4. envRecNのバインディングが未初期化なら、ReferenceError例外を投げる。
  5. envRecNに現在バインドされている値を返す。

Sは常にtrueになる。なぜなら、Moduleは常にstrict mode コードだからである。

9.1.1.5.2 DeleteBinding ( N )

モジュール環境レコード の DeleteBinding 具体メソッドはこの仕様内では使用されません。

モジュール環境レコードは厳格コード内でのみ使用され、厳格コードにおける早期エラー規則により、delete演算子がReference Recordに適用され、その参照先がモジュール環境レコードバインディングとなることを禁止している。13.5.1.1も参照。

9.1.1.5.3 HasThisBinding ( )

モジュール環境レコード envRec の HasThisBinding 具体メソッドは引数を取らず、trueを返す。呼び出されたとき次の手順を実行する:

  1. trueを返す。

モジュール環境レコードは常にthisバインディングを提供します。

9.1.1.5.4 GetThisBinding ( )

モジュール環境レコード envRec の GetThisBinding 具体メソッドは引数を取らず、undefined を含む正常完了を返す。呼び出されたとき次の手順を実行する:

  1. undefinedを返す。

9.1.1.5.5 CreateImportBinding ( envRec, N, M, N2 )

抽象操作 CreateImportBinding は、引数 envRecモジュール環境レコード)、N(文字列)、Mモジュールレコード)、N2(文字列)を取り、unusedを返す。これは、Nという名前の新しい初期化済み不変間接バインディングを作成する。envRecNのバインディングが既に存在してはいけない。N2Mモジュール環境レコードに存在するバインディング名。新しいバインディングの値へのアクセスはターゲットバインディングの値を間接的にアクセスする。呼び出されたとき次の手順を実行する:

  1. アサートenvRecは既にNのバインディングを持っていない。
  2. アサートM.[[Environment]]がインスタンス化されたとき、直接N2のバインディングを持つ。
  3. envRecNの不変間接バインディングを作成し、そのターゲットバインディングとしてMN2を参照し、初期化済みであることを記録する。
  4. unusedを返す。

9.1.2 環境レコードの操作

以下の抽象操作は、この仕様で環境レコードを操作するために使用されます:

9.1.2.1 GetIdentifierReference ( env, name, strict )

抽象操作 GetIdentifierReference は、引数 env環境レコードまたはnull)、name(文字列)、strict(ブール値)を取り、Reference Record を含む正常完了またはthrow completionを返します。呼び出されたとき次の手順を実行します:

  1. envnullなら、
    1. Reference Record { [[Base]]: unresolvable, [[ReferencedName]]: name, [[Strict]]: strict, [[ThisValue]]: empty } を返す。
  2. exists を ? env.HasBinding(name) とする。
  3. existstrueなら、
    1. Reference Record { [[Base]]: env, [[ReferencedName]]: name, [[Strict]]: strict, [[ThisValue]]: empty } を返す。
  4. それ以外の場合、
    1. outerenv.[[OuterEnv]] とする。
    2. ? GetIdentifierReference(outer, name, strict) を返す。

9.1.2.2 NewDeclarativeEnvironment ( E )

抽象操作 NewDeclarativeEnvironment は、引数 E環境レコード または null)を取り、宣言的環境レコード を返します。呼び出されたとき次の手順を実行します:

  1. env をバインディングが何もない新しい 宣言的環境レコード とする。
  2. env.[[OuterEnv]]E を設定する。
  3. env を返す。

9.1.2.3 NewObjectEnvironment ( O, W, E )

抽象操作 NewObjectEnvironment は、引数 O(オブジェクト)、W(ブール値)、E環境レコード または null)を取り、オブジェクト環境レコード を返します。呼び出されたとき次の手順を実行します:

  1. env を新しい オブジェクト環境レコード とする。
  2. env.[[BindingObject]]O を設定する。
  3. env.[[IsWithEnvironment]]W を設定する。
  4. env.[[OuterEnv]]E を設定する。
  5. env を返す。

9.1.2.4 NewFunctionEnvironment ( F, newTarget )

抽象操作 NewFunctionEnvironment は、引数 F(ECMAScript 関数オブジェクト)、newTarget(オブジェクトまたは undefined)を取り、関数環境レコード を返します。呼び出されたとき次の手順を実行します:

  1. env をバインディングが何もない新しい 関数環境レコード とする。
  2. env.[[FunctionObject]]F を設定する。
  3. F.[[ThisMode]]lexical なら、env.[[ThisBindingStatus]]lexical を設定する。
  4. それ以外の場合、env.[[ThisBindingStatus]]uninitialized を設定する。
  5. env.[[NewTarget]]newTarget を設定する。
  6. env.[[OuterEnv]]F.[[Environment]] を設定する。
  7. env を返す。

9.1.2.5 NewGlobalEnvironment ( G, thisValue )

抽象操作 NewGlobalEnvironment は、引数 G(オブジェクト)、thisValue(オブジェクト)を取り、グローバル環境レコード を返します。呼び出されたとき次の手順を実行します:

  1. objRecNewObjectEnvironment(G, false, null) とする。
  2. dclRecNewDeclarativeEnvironment(null) とする。
  3. env を新しい グローバル環境レコード とする。
  4. env.[[ObjectRecord]]objRec を設定する。
  5. env.[[GlobalThisValue]]thisValue を設定する。
  6. env.[[DeclarativeRecord]]dclRec を設定する。
  7. env.[[OuterEnv]]null を設定する。
  8. env を返す。

9.1.2.6 NewModuleEnvironment ( E )

抽象操作 NewModuleEnvironment は、引数 E環境レコード)を取り、モジュール環境レコード を返します。呼び出されたとき次の手順を実行します:

  1. env をバインディングが何もない新しい モジュール環境レコード とする。
  2. env.[[OuterEnv]]E を設定する。
  3. env を返す。

9.2 プライベート環境レコード

プライベート環境レコードは、ECMAScriptコード内のClassDeclarationClassExpressionの字句的入れ子構造に基づいてプライベート名を追跡するために使われる仕様メカニズムです。これは環境レコードに似ていますが、異なるものです。各プライベート環境レコードは、ClassDeclarationまたはClassExpressionに関連付けられています。このようなクラスが評価されるたびに、そのクラスによって宣言されたプライベート名を記録する新しいプライベート環境レコードが作成されます。

プライベート環境レコードは、表23で定義されたフィールドを持ちます。

表23: プライベート環境レコードのフィールド
フィールド名 値の型 意味
[[OuterPrivateEnvironment]] プライベート環境レコード または null 最も近い外側のクラスのプライベート環境レコード。 このプライベート環境レコードが関連付けられているクラスが他のクラスに包含されていない場合はnull
[[Names]] リストプライベート名のリスト) このクラスによって宣言されたプライベート名

9.2.1 プライベート環境レコードの操作

以下の抽象操作は、この仕様でプライベート環境レコードを操作するために使用されます:

9.2.1.1 NewPrivateEnvironment ( outerPrivateEnv )

抽象操作 NewPrivateEnvironment は、引数 outerPrivateEnvプライベート環境レコード または null)を取り、プライベート環境レコードを返す。呼び出されたとき次の手順を実行する:

  1. names を新しい空の リスト とする。
  2. プライベート環境レコード { [[OuterPrivateEnvironment]]: outerPrivateEnv, [[Names]]: names } を返す。

9.2.1.2 ResolvePrivateIdentifier ( privateEnv, identifier )

抽象操作 ResolvePrivateIdentifier は、引数 privateEnvプライベート環境レコード)、identifier(文字列)を取り、プライベート名を返す。呼び出されたとき次の手順を実行する:

  1. namesprivateEnv.[[Names]] とする。
  2. names の各プライベート名 pnについて、
    1. pn.[[Description]]identifier であれば、
      1. pn を返す。
  3. outerPrivateEnvprivateEnv.[[OuterPrivateEnvironment]] とする。
  4. アサートouterPrivateEnvnullではない。
  5. ResolvePrivateIdentifier(outerPrivateEnv, identifier) を返す。

9.3 レルム

評価される前に、すべてのECMAScriptコードはレルムに関連付けられていなければなりません。概念的には、レルムは、一連の組み込みオブジェクト、ECMAScriptグローバル環境、そのグローバル環境のスコープ内でロードされたすべてのECMAScriptコード、およびその他の関連する状態やリソースから構成されます。

レルムは、この仕様ではレルムレコードとして表現され、表24で指定されるフィールドを持ちます:

表24: レルムレコードのフィールド
フィールド名 意味
[[AgentSignifier]] エージェント識別子 このレルムを所有するエージェント
[[Intrinsics]] レコードであり、フィールド名は組み込みキー、値はオブジェクト このレルムに関連するコードで使用される組み込み値
[[GlobalObject]] オブジェクト このレルムグローバルオブジェクト
[[GlobalEnv]] グローバル環境レコード このレルムのグローバル環境
[[TemplateMap]] リスト(各要素はレコードで、[[Site]]TemplateLiteral 構文ノード)、[[Array]](配列)フィールドを持つ)

テンプレートオブジェクトは各レルムごとに、そのレルムレコード[[TemplateMap]]を使って正規化される。各[[Site]]値は構文ノードTemplateLiteral)。対応する[[Array]]値はタグ関数に渡されるテンプレートオブジェクト。

注1
ある構文ノードが到達不能になると、対応する[[Array]]も到達不能となり、実装が[[TemplateMap]]リストからそのペアを削除しても観測できない。
[[LoadedModules]] リスト(各要素はLoadedModuleRequestレコード

このレルムでimportされたspecifier文字列から解決されたモジュールレコードへのマップ。このリストにはレコードr1, r2でModuleRequestsEqual(r1, r2)がtrueとなるような2つの異なるレコードは含まれない。

注2
HostLoadImportedModule16.2.1.10注1)で述べられているように、レルムレコード[[LoadedModules]]は、import()式がアクティブなスクリプトまたはモジュールのないコンテキストで実行される場合のみ使用される。
[[HostDefined]] 任意(デフォルト値はundefined ホストレルムレコードに追加情報を関連付ける必要がある場合に予約されたフィールド。

9.3.1 InitializeHostDefinedRealm ( )

抽象操作 InitializeHostDefinedRealm は引数を取らず、unused を含む正常完了またはthrow completionを返す。呼び出されたとき次の手順を実行する:

  1. realm を新しいレルムレコードとする。
  2. CreateIntrinsics(realm)を実行する。
  3. realm.[[AgentSignifier]]AgentSignifier()の値を設定する。
  4. realm.[[TemplateMap]]に新しい空のリストを設定する。
  5. newContext を新しい実行コンテキストとする。
  6. newContextのFunctionをnullに設定する。
  7. newContextレルムrealmに設定する。
  8. newContextのScriptOrModuleをnullに設定する。
  9. newContext実行コンテキストスタックにプッシュする。newContext実行中の実行コンテキストとなる。
  10. ホストエキゾチックオブジェクトrealmグローバルオブジェクトとして必要とする場合、
    1. globalをそのようなオブジェクトとしてホスト定義の方法で作成する。
  11. それ以外の場合、
    1. globalOrdinaryObjectCreate(realm.[[Intrinsics]].[[%Object.prototype%]])とする。
  12. ホストrealmのグローバルスコープのthisバインディングをグローバルオブジェクト以外のオブジェクトにする必要がある場合、
    1. thisValueをそのようなオブジェクトとしてホスト定義の方法で作成する。
  13. それ以外の場合、
    1. thisValueglobalとする。
  14. realm.[[GlobalObject]]globalを設定する。
  15. realm.[[GlobalEnv]]NewGlobalEnvironment(global, thisValue)を設定する。
  16. SetDefaultGlobalBindings(realm)を実行する。
  17. ホスト定義グローバルオブジェクトプロパティをglobalに作成する。
  18. unusedを返す。

9.3.2 CreateIntrinsics ( realmRec )

抽象操作 CreateIntrinsics は、引数 realmRecレルムレコード)を取り、unusedを返す。呼び出されたとき次の手順を実行する:

  1. realmRec.[[Intrinsics]] に新しいレコードを設定する。
  2. realmRec.[[Intrinsics]]のフィールドに、表6に記載の値を設定する。フィールド名は表の第1列。値は、この仕様の 19 から 28 各オブジェクトの仕様に従って完全かつ再帰的にプロパティ値が設定された新しいオブジェクト値。すべてのオブジェクトプロパティ値は新しいオブジェクト値。組み込み関数オブジェクトCreateBuiltinFunction(steps, length, name, slots, realmRec, prototype) で作成される。stepsはこの仕様で定義された関数、nameは関数の"name"プロパティの初期値、length"length"プロパティの初期値、slotsは内部スロット名リスト、prototype[[Prototype]]内部スロットの指定値。組み込みとそのプロパティの作成順序は、未作成のオブジェクトへの依存が発生しないようにしなければならない。
  3. AddRestrictedFunctionProperties(realmRec.[[Intrinsics]].[[%Function.prototype%]], realmRec)を実行する。
  4. unusedを返す。

9.3.3 SetDefaultGlobalBindings ( realmRec )

抽象操作 SetDefaultGlobalBindings は、引数 realmRecレルムレコード)を取り、unused を含む正常完了またはthrow completionを返す。呼び出されたとき次の手順を実行する:

  1. globalrealmRec.[[GlobalObject]]とする。
  2. 19で指定されるグローバルオブジェクトの各プロパティについて、
    1. nameプロパティ名の文字列値とする。
    2. descを、そのプロパティの指定属性を含む完全なデータプロパティディスクリプタとする。19.219.319.4に列挙されるプロパティの場合、[[Value]]属性の値はrealmRecの対応する組み込みオブジェクト。
    3. DefinePropertyOrThrow(global, name, desc)を実行する。
  3. unusedを返す。

9.4 実行コンテキスト

実行コンテキストは、ECMAScriptの実装によるコードの実行時評価を追跡するために使用される仕様デバイスです。任意の時点で、実際にコードを実行しているエージェントごとに最大1つの実行コンテキストしか存在しません。これは、そのエージェント実行中の実行コンテキストとして知られます。本仕様における実行中の実行コンテキストへのすべての参照は、周囲のエージェント実行中の実行コンテキストを指します。

実行コンテキストスタックは、実行コンテキストを追跡するために使用されます。実行中の実行コンテキストは常にこのスタックの最上位要素です。現在の実行中の実行コンテキストに関連付けられている実行可能コードから、関連付けられていない実行可能コードへ制御が移るたびに、新しい実行コンテキストが作成されます。新たに作成された実行コンテキストはスタックにプッシュされ、実行中の実行コンテキストとなります。

実行コンテキストは、それに関連付けられたコードの実行進捗を追跡するために必要な実装依存の状態を含みます。各実行コンテキストは、少なくとも表25に記載された状態コンポーネントを持ちます。

表25: すべての実行コンテキストの状態コンポーネント
コンポーネント 目的
code evaluation state この実行コンテキストに関連付けられたコードの評価を実行・中断・再開するために必要なすべての状態。
Function もしこの実行コンテキスト関数オブジェクトのコードを評価している場合、このコンポーネントの値はその関数オブジェクトです。コンテキストがScriptまたはModuleのコードを評価している場合、値はnullとなります。
Realm 関連コードがECMAScriptリソースへアクセスするために利用するRealm Record
ScriptOrModule 関連コードが由来するModule RecordまたはScript Record。オリジナルの実行コンテキストInitializeHostDefinedRealmで作成される場合など、スクリプトやモジュールが存在しない場合はnullとなります。

Evaluationにより、実行中の実行コンテキストによるコードの評価は、本仕様で定義された様々な時点で中断されることがあります。実行中の実行コンテキストが中断された場合、別の実行コンテキストが実行中の実行コンテキストとなり、そのコードの評価を開始します。後の時点で、中断されていた実行コンテキストが再び実行中の実行コンテキストとなり、中断された箇所からコードの評価を再開することがあります。実行中の実行コンテキストの状態遷移は通常、スタックの後入れ先出し(LIFO)の方法で行われます。ただし、一部のECMAScriptの機能では、実行中の実行コンテキストの非LIFOな遷移が必要となることがあります。

Realmコンポーネントの値は、実行中の実行コンテキストにおいて現在のRealm Recordとも呼ばれます。実行中の実行コンテキストのFunctionコンポーネントの値はアクティブな関数オブジェクトとも呼ばれます。

ECMAScriptコード実行コンテキストは、表26に記載された追加の状態コンポーネントを持ちます。

表26: ECMAScriptコード実行コンテキストの追加状態コンポーネント
コンポーネント 目的
LexicalEnvironment この実行コンテキスト内でコードによって行われる識別子参照を解決するために使用されるEnvironment Recordを識別します。
VariableEnvironment この実行コンテキスト内でVariableStatementによって作成されるバインディングを保持するEnvironment Recordを識別します。
PrivateEnvironment 直近の包含クラス内でClassElementによって作成されたPrivate Namesを保持するPrivateEnvironment Recordを識別します。包含クラスが存在しない場合はnullです。

実行コンテキストのLexicalEnvironmentおよびVariableEnvironmentコンポーネントは常にEnvironment Recordです。

ジェネレーターの評価を表す実行コンテキストは、表27に記載された追加の状態コンポーネントを持ちます。

表27: ジェネレーター実行コンテキストの追加状態コンポーネント
コンポーネント 目的
Generator この実行コンテキストが評価しているGenerator。

ほとんどの場合、仕様内のアルゴリズムによって直接操作されるのは実行中の実行コンテキスト実行コンテキストスタックの最上位)だけです。そのため、「LexicalEnvironment」や「VariableEnvironment」という用語が修飾なしで使われている場合、それは実行中の実行コンテキストのこれらのコンポーネントを指します。

実行コンテキストは純粋に仕様上の仕組みであり、ECMAScript実装の特定の構造体に対応している必要はありません。ECMAScriptコードから直接実行コンテキストにアクセスしたり観察したりすることはできません。

9.4.1 GetActiveScriptOrModule ( )

抽象操作GetActiveScriptOrModuleは引数を取らず、Script RecordModule Record、またはnullを返します。これは実行中の実行コンテキストに基づき、現在実行中のスクリプトまたはモジュールを判定するために使用されます。呼び出し時、次の手順を実行します:

  1. もし実行コンテキストスタックが空であれば、nullを返す。
  2. ecを、実行コンテキストスタック上のScriptOrModuleコンポーネントがnullでない最上位の実行コンテキストとする。
  3. そのような実行コンテキストが存在しない場合、nullを返す。そうでなければ、ecのScriptOrModuleを返す。

9.4.2 ResolveBinding ( name [ , env ] )

抽象操作ResolveBindingは、引数name(文字列)および省略可能な引数envEnvironment Recordまたはundefined)を取り、normal completion containingReference Recordまたはthrow completionのいずれかを返します。これはnameのバインディングを判定するために使用されます。envでバインディングを検索するEnvironment Recordを明示的に指定できます。呼び出し時、次の手順を実行します:

  1. もしenvが指定されていない、またはenvundefinedの場合、
    1. env実行中の実行コンテキストのLexicalEnvironmentを設定する。
  2. 保証envEnvironment Recordである。
  3. strictIsStrict(評価中の構文生成規則)とする。
  4. 戻り値は? GetIdentifierReference(env, name, strict)とする。

ResolveBindingの結果は常に、その[[ReferencedName]]フィールドがnameとなるReference Recordです。

9.4.3 GetThisEnvironment ( )

抽象操作GetThisEnvironmentは引数を取らず、Environment Recordを返します。これは、現在キーワードthisのバインディングを提供するEnvironment Recordを見つけます。呼び出し時、次の手順を実行します:

  1. env実行中の実行コンテキストのLexicalEnvironmentとする。
  2. 繰り返す。
    1. existsenv.HasThisBinding()とする。
    2. もしexiststrueなら、envを返す。
    3. outerenv.[[OuterEnv]]とする。
    4. 保証outernullでない。
    5. envouterを設定する。

ステップ2のループは必ず終了します。なぜなら、環境のリストは必ずthisバインディングを持つグローバル環境で終わるからです。

9.4.4 ResolveThisBinding ( )

抽象操作ResolveThisBindingは引数を取らず、normal completion containingECMAScript言語値またはthrow completionを返します。これは、実行中の実行コンテキストのLexicalEnvironmentを使ってキーワードthisのバインディングを決定します。呼び出し時、次の手順を実行します:

  1. envRecGetThisEnvironment()とする。
  2. 戻り値は? envRec.GetThisBinding()とする。

9.4.5 GetNewTarget ( )

抽象操作GetNewTargetは引数を取らず、オブジェクトまたはundefinedを返します。これは、実行中の実行コンテキストのLexicalEnvironmentを使ってNewTarget値を決定します。呼び出し時、次の手順を実行します:

  1. envRecGetThisEnvironment()とする。
  2. 保証envRec[[NewTarget]]フィールドを持つ。
  3. 戻り値はenvRec.[[NewTarget]]とする。

9.4.6 GetGlobalObject ( )

抽象操作GetGlobalObjectは引数を取らず、オブジェクトを返します。これは、現在の実行中の実行コンテキストが使用するグローバルオブジェクトを返します。呼び出し時、次の手順を実行します:

  1. currentRealm現在のRealm Recordとする。
  2. 戻り値はcurrentRealm.[[GlobalObject]]とする。

9.5 ジョブおよびジョブをキューに入れるためのホスト操作

ジョブとは、パラメータを持たず、他のECMAScript計算が現在進行中でないときにECMAScript計算を開始する抽象クロージャです。

ジョブは、ECMAScriptホスト環境によって、特定のエージェントで実行されるようにスケジュールされます。本仕様では、ジョブをスケジュールするためのホストフックであるHostEnqueueGenericJobHostEnqueueFinalizationRegistryCleanupJobHostEnqueuePromiseJob、およびHostEnqueueTimeoutJobを説明します。本仕様のホストフックは、ジョブのスケジューリングに課される追加の制約によって整理されています。ホストは、さらにジョブをスケジュールする抽象操作を定義してもかまいません。そのような操作は、ジョブとなる抽象クロージャと、realmRealm Recordまたはnull)をパラメータとして受け取ります。Realm Recordが指定された場合、これらの操作は、そのrealmを所有するエージェントで、提供されたrealmで将来のある時点でジョブを実行するようにスケジュールします。realmnullが指定された場合、そのジョブはECMAScriptコードを評価しません。これらの実装は、以下の要件に準拠しなければなりません。

注1
ホスト環境は、スケジューリングに関してジョブを一様に扱う必要はありません。例えば、WebブラウザやNode.jsはPromise処理のジョブを他の作業よりも高い優先度で扱います。将来の機能追加では、これほど高い優先度で扱われないジョブが追加される可能性があります。

ある時点で、すべての次の条件が真であれば、scriptOrModuleScript RecordModule Record、またはnull)はアクティブなスクリプトまたはモジュールです:

ある時点で、すべての次の条件が真であれば、実行はECMAScriptコードを評価する準備ができている状態です:

注2

ホスト環境は、実行コンテキストスタック実行コンテキストをプッシュすることで、コード評価のための実行準備を行うことがあります。その具体的なステップは実装依存です。

Realmの具体的な選択はホスト環境に委ねられます。この初期の実行コンテキストRealmは、コールバック関数が呼び出される前にのみ使用されます。Promiseハンドラのようなジョブに関連するコールバック関数が呼び出されると、その呼び出しは自身の実行コンテキストRealmをプッシュします。

特定の種類のジョブには、追加の適合要件があります。

9.5.1 JobCallbackレコード

JobCallbackレコードは、Record値であり、関数オブジェクトおよびホスト定義値を保存するために使われます。ホストによってキューに入れられたジョブを通して呼び出される関数オブジェクトは、追加のホスト定義コンテキストを持つ場合があります。この状態を伝播するために、ジョブ抽象クロージャは、関数オブジェクトを直接キャプチャして呼び出すべきではありません。代わりにHostMakeJobCallbackHostCallJobCallbackを使用してください。

WHATWG HTML仕様(https://html.spec.whatwg.org/)は、例えばPromiseコールバックのためにインカンバント設定オブジェクトを伝播するためにホスト定義値を利用します。

JobCallbackレコードは、表28に示すフィールドを持ちます。

表28: JobCallback Recordフィールド
フィールド名 意味
[[Callback]] 関数オブジェクト ジョブが呼び出されたときに呼び出す関数。
[[HostDefined]] 任意の値(デフォルト値はempty ホストが利用するためのフィールド。

9.5.2 HostMakeJobCallback ( callback )

ホスト定義抽象操作HostMakeJobCallbackは、引数callback関数オブジェクト)を受け取り、JobCallbackレコードを返します。

HostMakeJobCallbackの実装は、以下の要件を満たさなければなりません:

HostMakeJobCallbackのデフォルト実装は、呼び出し時に次の手順を実行します:

  1. JobCallbackレコード { [[Callback]]: callback, [[HostDefined]]: empty }を返す。

WebブラウザでないECMAScriptホストは、HostMakeJobCallbackのデフォルト実装を使用しなければなりません。

これは、コールバックが最終的にスケジュールされ実行される責任を持つ関数に渡された時点で呼び出されます。たとえば、promise.then(thenAction)Promise.prototype.thenの呼び出し時にthenActionに対してMakeJobCallbackを呼び出しますが、リアクションジョブがスケジュールされる時ではありません。

9.5.3 HostCallJobCallback ( jobCallback, V, argumentsList )

ホスト定義抽象操作HostCallJobCallbackは、引数jobCallbackJobCallbackレコード)、VECMAScript言語値)、argumentsListList(各要素はECMAScript言語値))を受け取り、normal completion containingECMAScript言語値またはthrow completionを返します。

HostCallJobCallbackの実装は、以下の要件を満たさなければなりません:

  • Call(jobCallback.[[Callback]], V, argumentsList)を実行し、その結果を返さなければなりません。

この要件は、ホストが本仕様で定義された関数オブジェクト[[Call]]の動作を変更できないことを意味します。

HostCallJobCallbackのデフォルト実装は、呼び出し時に次の手順を実行します:

  1. 保証: IsCallable(jobCallback.[[Callback]])はtrueである。
  2. ? Call(jobCallback.[[Callback]], V, argumentsList)を返す。

WebブラウザでないECMAScriptホストは、HostCallJobCallbackのデフォルト実装を使用しなければなりません。

9.5.4 HostEnqueueGenericJob ( job, realm )

ホスト定義抽象操作HostEnqueueGenericJobは、引数jobジョブ抽象クロージャ)とrealmRealm Record)を受け取り、unusedを返します。これは、realm.[[AgentSignifier]]で示されるエージェント内のrealmrealmjobを将来のある時点で実行するようにスケジュールします。このアルゴリズムで利用される抽象クロージャは、優先度や順序などの追加制約なしにスケジュールされることを意図しています。

HostEnqueueGenericJobの実装は、9.5の要件に準拠しなければなりません。

9.5.5 HostEnqueuePromiseJob ( job, realm )

ホスト定義抽象操作HostEnqueuePromiseJobは、引数jobジョブ抽象クロージャ)とrealmRealm Recordまたはnull)を受け取り、unusedを返します。これは、jobを将来のある時点で実行するようにスケジュールします。このアルゴリズムで利用される抽象クロージャは、Promiseの処理に関連するか、Promise処理操作と同等の優先度でスケジュールされることを意図しています。

HostEnqueuePromiseJobの実装は、9.5の要件に加えて、次の要件にも準拠しなければなりません:

NewPromiseResolveThenableJobが返すジョブrealmは、通常then関数オブジェクトに対してGetFunctionRealmを呼び出した結果となります。NewPromiseReactionJobが返すジョブrealmは、通常ハンドラがundefinedでなければ、そのハンドラに対してGetFunctionRealmを呼び出した結果となります。ハンドラがundefinedの場合、realmnullです。両方のジョブについて、GetFunctionRealmが異常終了した場合(例:revokeされたProxy上で呼び出された場合)、realm現在のRealm Recordになります。realmnullの場合、ユーザーECMAScriptコードは評価されず、新たなECMAScriptオブジェクト(例:Errorオブジェクト)は作成されません。例えばWHATWG HTML仕様(https://html.spec.whatwg.org/)では、realmを使ってスクリプトの実行可否やentry概念のチェックを行います。

9.5.6 HostEnqueueTimeoutJob ( timeoutJob, realm, milliseconds )

ホスト定義抽象操作HostEnqueueTimeoutJobは、引数timeoutJobJob 抽象クロージャ)、realmRealm Record)、およびmilliseconds(非負の有限数値)を取り、unusedを返す。これは、realmrealm内のagentrealm.[[AgentSignifier]]で示される)において、少なくともmillisecondsミリ秒後にtimeoutJobが実行されるようにスケジューリングする。

HostEnqueueTimeoutJobの実装は、9.5の要件に準拠しなければならない。

9.6 エージェント

エージェントは、一連のECMAScript実行コンテキスト実行コンテキストスタック実行中の実行コンテキストエージェントレコード、および実行スレッドから構成されます。実行スレッドを除き、エージェントの構成要素はそのエージェントにのみ属します。

エージェント実行スレッドは、他のエージェントとは独立して、そのエージェント実行コンテキスト上でアルゴリズムステップを実行します。ただし、実行スレッドが、複数のエージェントによって使用されることがあっても、スレッドを共有しているエージェントのいずれも、そのエージェントレコード[[CanBlock]]フィールドがtrueでない限り許されます。

注1

例えば、一部のウェブブラウザーは、複数の無関係なタブ間で一つの実行スレッドを共有します。

エージェント実行スレッドがアルゴリズムステップを実行している間、そのエージェントはこれらのステップの周囲のエージェントとなります。これらのステップは周囲のエージェントを使って、エージェント内に保持された仕様レベルの実行オブジェクト(実行中の実行コンテキスト実行コンテキストスタックエージェントレコードのフィールド)へアクセスします。

エージェント識別子は、エージェントを識別するために使用されるグローバルに一意な不透明値です。

表29: エージェントレコードのフィールド
フィールド名 意味
[[LittleEndian]] Boolean GetValueFromBufferおよびSetValueInBufferアルゴリズムでisLittleEndianパラメータが必要な場合のデフォルト値。値の選択は実装依存であり、実装にとって最も効率的な代替案であるべきです。一度観測された値は変更できません。
[[CanBlock]] Boolean エージェントがブロック可能かどうかを決定します。
[[Signifier]] エージェント識別子 自身のエージェントクラスタ内でエージェントを一意に識別します。
[[IsLockFree1]] Boolean 1バイト値のアトミック操作がロックフリーならtrue、そうでなければfalse
[[IsLockFree2]] Boolean 2バイト値のアトミック操作がロックフリーならtrue、そうでなければfalse
[[IsLockFree8]] Boolean 8バイト値のアトミック操作がロックフリーならtrue、そうでなければfalse
[[CandidateExecution]] 候補実行Record メモリーモデルを参照。
[[KeptAlive]] List(要素はObjectまたはSymbol) 新たな空Listから始まり、現在のJobが終了するまで生存させるべきオブジェクトやシンボルのリスト。
[[ModuleAsyncEvaluationCount]] 整数 初期値0。非同期もしくは非同期依存を持つモジュールの[[AsyncEvaluationOrder]]フィールドに一意な増加値を割り当てるために使用。

[[Signifier]][[IsLockFree1]][[IsLockFree2]]の値は、一度エージェントクラスタ内のいずれかのエージェントによって観測された場合、変更できません。

注2

[[IsLockFree1]]および[[IsLockFree2]]の値は、必ずしもハードウェアによって決まるものではなく、実装ごと・時間ごとに異なる実装選択を反映することがあります。

[[IsLockFree4]]フィールドは存在しません。4バイトのアトミック操作は常にロックフリーです。

実際には、アトミック操作が何らかのロックを伴って実装されている場合、その操作はロックフリーではありません。ロックフリーはウェイトフリーを意味せず、ロックフリーなアトミック操作を完了するのに必要なマシンステップ数に上限はありません。

サイズnのアトミックアクセスがロックフリーであることは、サイズnの非アトミックアクセスの(見かけ上の)アトミシティについては何も意味しません。具体的には、非アトミックアクセスは複数の個別なメモリアクセスの連続として実行されることがあります。詳細はReadSharedMemoryおよびWriteSharedMemoryを参照してください。

注3

エージェントは仕様上の仕組みであり、ECMAScript実装の特定の構造体に対応している必要はありません。

9.6.1 AgentSignifier ( )

抽象操作AgentSignifierは引数を取らず、エージェント識別子を返します。呼び出し時、次の手順を実行します:

  1. AR周囲のエージェントエージェントレコードとする。
  2. AR.[[Signifier]]を返す。

9.6.2 AgentCanSuspend ( )

抽象操作AgentCanSuspendは引数を取らず、Booleanを返します。呼び出し時、次の手順を実行します:

  1. AR周囲のエージェントエージェントレコードとする。
  2. AR.[[CanBlock]]を返す。

環境によっては、特定のエージェントのサスペンドが合理的でない場合があります。例えば、ウェブブラウザー環境では、ドキュメントのメインイベント処理スレッドのサスペンドを許可せず、ワーカーのイベント処理スレッドのみサスペンドを許可するのが合理的かもしれません。

9.6.3 IncrementModuleAsyncEvaluationCount ( )

抽象操作IncrementModuleAsyncEvaluationCountは引数を取らず、整数を返します。呼び出し時、次の手順を実行します:

  1. AR周囲のエージェントエージェントレコードとする。
  2. countAR.[[ModuleAsyncEvaluationCount]]とする。
  3. AR.[[ModuleAsyncEvaluationCount]]count+1を設定する。
  4. countを返す。

この値は未処理モジュール間の相対評価順序を追跡するためだけに使用されます。未処理モジュールが存在しない場合、実装は[[ModuleAsyncEvaluationCount]]を密かに0にリセットしてもかまいません。

9.7 エージェントクラスタ

エージェントクラスタは、共有メモリ上で操作することで通信できるエージェントの極大集合です。

注1

異なるエージェントのプログラムは、未規定の手段でメモリを共有する場合があります。少なくとも、SharedArrayBufferのバックメモリはクラスタ内のエージェント間で共有できます。

メッセージパッシングによってのみ通信でき、メモリを共有できないエージェントも存在する場合があります。これらは決して同じエージェントクラスタには属しません。

すべてのエージェントは、正確に1つのエージェントクラスタに属します。

注2

クラスタ内のエージェントは、ある時点ですべてが生存している必要はありません。エージェントAが別のエージェントBを生成し、その後Aが終了し、BエージェントCを生成した場合、ABとメモリを共有でき、BCとメモリを共有できるなら、この3つのエージェントは同じクラスタに属します。

クラスタ内のすべてのエージェントは、それぞれのエージェントレコード[[LittleEndian]]フィールドの値が同じでなければなりません。

注3

同一エージェントクラスタ内で異なるエージェントが異なる[[LittleEndian]]値を持つ場合、複数バイトデータの共有メモリ利用が困難になります。

クラスタ内のすべてのエージェントは、それぞれのエージェントレコード[[IsLockFree1]]フィールドの値が同じでなければなりません。[[IsLockFree2]]フィールドについても同様です。

クラスタ内のすべてのエージェントは、それぞれのエージェントレコード[[Signifier]]フィールドの値が異なっていなければなりません。

埋め込み環境は、エージェントの知識や協力なしに、そのエージェントの進行を停止(非アクティブ化)または再開(アクティブ化)してもかまいません。その場合、クラスタ内の一部のエージェントだけがアクティブなまま、他のエージェントが無期限に非アクティブな状態にしてはなりません。

注4

この制約は、他のエージェントが非アクティブ化された結果、エージェントがデッドロックやスターブ状態になる事態を防ぐためです。たとえば、HTMLの共有ワーカーがウィンドウのドキュメントと独立して存続でき、独立したドキュメントの専用ワーカーとメモリを共有できる場合、そのドキュメントと専用ワーカーが非アクティブ化され、専用ワーカーがロックを保持していた場合(例えばドキュメントがウィンドウ履歴にプッシュされた場合)、共有ワーカーがそのロック取得を試みると、専用ワーカーが再度アクティブ化されるまでブロックされます。その間、他のウィンドウから共有ワーカーへのアクセスを試みるワーカーはスターブします。

この制約の帰結として、埋め込み環境内で同じサスペンド/ウェイク集団に属さないエージェント同士でメモリを共有することはできなくなります。

埋め込み環境は、クラスタ内の他のエージェントの事前の知識や協力なしにエージェントを終了させてもかまいません。もしエージェントが自身またはクラスタ内の他のエージェントによるプログラム的操作でなく、クラスタ外部の要因で終了させられる場合、埋め込み環境は2つの戦略のいずれかを選ばなければなりません:クラスタ内のすべてのエージェントを終了させるか、クラスタ内のエージェントが協調できる信頼性のあるAPIを提供し、クラスタ内の少なくとも1つのメンバーが終了を検知できるようにし、終了データには終了したエージェントを特定できる十分な情報を含めること。

注5

この種の終了の例:異なるプロセスで動作するエージェントをOSやユーザーが終了させる場合、同じプロセス内で他のエージェントと共に動作しているエージェントを、エージェント単位のリソース管理に基づき暴走と判定されて終了させる場合など。

以下の仕様値およびそれらから伝播的に到達可能な値は、正確に1つのエージェントクラスタに属します。

クラスタ内のいずれかのエージェントによるECMAScriptコードの評価前に、クラスタ内のすべてのエージェントレコード[[CandidateExecution]]フィールドは初期候補実行に設定されます。初期候補実行は、[[EventsRecords]]フィールドが、各エージェントについてそのエージェント識別子[[AgentSignifier]]フィールドに持ち、[[EventList]]および[[AgentSynchronizesWith]]フィールドが空ListであるAgent Events Recordを格納したListである、空の候補実行です。

注6

同じエージェントクラスタ内のすべてのエージェントは、エージェントレコード[[CandidateExecution]]フィールドで同じ候補実行を共有します。候補実行メモリーモデルで使用される仕様の仕組みです。

注7

エージェントクラスタは仕様上の仕組みであり、ECMAScript実装の特定の構造物に対応している必要はありません。

9.8 フォワードプログレス

エージェントフォワードプログレスを行うとは、本仕様に従って評価ステップを実行することを指します。

エージェントは、その実行中の実行コンテキストが外部イベントを同期的かつ無期限に待機する場合にブロックされます。この意味でブロックされるのは、エージェントエージェントレコード[[CanBlock]]フィールドがtrueである場合のみです。アンブロックされたエージェントは、ブロックされていないものを指します。

実装は以下を保証しなければなりません:

これはメモリーモデルにおけるライブネス保証と合わせて、すべてのseq-cst書き込みが最終的にすべてのエージェントから観測可能になることを保証します。

9.9 WeakRefおよびFinalizationRegistryターゲットの処理モデル

9.9.1 目標

本仕様は、いかなるオブジェクトやシンボルもガベージコレクションされることを保証しません。ライブでないオブジェクトやシンボルは、長い期間の後に解放されることも、まったく解放されないこともあります。このため、本仕様ではガベージコレクションによって引き起こされる挙動について「may」という表現を使用します。

WeakRefおよびFinalizationRegistryのセマンティクスは、特定のタイミングで発生する2つの操作に基づいています:

  • WeakRef.prototype.derefが呼ばれたとき、(undefinedが返されない場合)参照先は生存し続け、以降の同期的なアクセスでも同じ値が返されます。このリストは、同期的な作業がClearKeptObjects抽象操作によって終了したときにリセットされます。
  • FinalizationRegistryに登録されたオブジェクトやシンボルが到達不能になった場合、同期的なECMAScript実行が完了した後、FinalizationRegistryのクリーンアップコールバックの呼び出しが最終的に行われることがあります。クリーンアップはCleanupFinalizationRegistry抽象操作で実行されます。

これらのアクション(ClearKeptObjectsまたはCleanupFinalizationRegistry)は、同期的なECMAScript実行を中断してはなりません。ホストがより長い同期的なECMAScript実行を構成することがあるため、本仕様ではClearKeptObjectsおよびCleanupFinalizationRegistryのスケジューリングをホスト環境に委ねます。

一部のECMAScript実装には、ECMAScriptがアイドル状態のときも含めてバックグラウンドで動作するガベージコレクタの実装が含まれています。ホスト環境CleanupFinalizationRegistryをスケジュールできることで、ファイナライザ処理を実行するためにECMAScriptの実行を再開し、保持値を解放して全体のメモリ使用量を削減できるようになります。

9.9.2 ライブネス

あるオブジェクトやシンボルの集合Sについて、仮想的なWeakRef非考慮実行とは、Sの要素を参照するWeakRefDeref抽象操作が常にundefinedを返すような実行のことです。

注1
WeakRef非考慮性とライブネスは2つの概念を捉えます。1つはWeakRef自身は参照先を生存させないこと。もう1つはライブネスの循環がその値がライブであることを意味しないことです。具体的には、あるvのライブネス判定がWeakRef参照先rのライブネスに依存している場合、rのライブネスはvのライブネスを前提にしてはなりません(循環論法禁止)。
注2
WeakRef非考慮性は、サイクルを考慮するために個々の値ではなく集合に対して定義されています。もし個々の値で定義した場合、サイクル内のWeakRef参照先は、サイクル内の他のWeakRef参照先を通じてのみ識別される場合にもライブと見なされてしまいます。
注3
通常、個々のオブジェクトやシンボルがライブであるとは、それを含むすべての集合がライブである場合を指します。

評価中の任意の時点で、オブジェクトやシンボルの集合Sは、次のいずれかの条件を満たす場合にライブと見なされます:

  • S内のいずれかの要素が、いずれかのエージェント[[KeptAlive]]Listに含まれている。
  • Sのいずれかの値の識別性を観測する有効な将来の仮想的なWeakRef非考慮実行が存在する。
注4
上記2番目の条件は、値が非WeakRef手段で識別可能な場合にライブである、という直感を捉えています。値の識別性は、厳密等価比較やMapのキーとして使われることで観測できます。
注5

フィールド、内部スロット、またはプロパティにオブジェクトやシンボルが存在することは、その値がライブであることを意味しません。たとえば、その値がプログラムに返されない場合は観測できません。

これはWeakMapのキーやWeakSetのメンバー、FinalizationRegistryセルレコードの[[WeakRefTarget]][[UnregisterToken]]フィールドにも当てはまります。

上記定義は、WeakMapのキーがライブでない場合、その対応する値も必ずしもライブでないことを意味します。

注6
ライブネスは、エンジンが空にしてはならないWeakRefの下限です。ここで定義されるライブネスは決定不能です。実際には、エンジンは到達可能性などの保守的な近似を使用します。実装には大きな裁量が期待されます。

9.9.3 実行

任意の時点で、オブジェクトやシンボルの集合Sライブでない場合、ECMAScript実装は次の手順をアトミックに実行することができます:

  1. Sの各要素valueについて、次を行う
    1. ref.[[WeakRefTarget]]valueであるWeakRef refそれぞれについて、次を行う
      1. ref.[[WeakRefTarget]]emptyに設定する。
    2. fg.[[Cells]]に、cell.[[WeakRefTarget]]valueであるRecord cellを含むFinalizationRegistry fgそれぞれについて、次を行う
      1. cell.[[WeakRefTarget]]emptyに設定する。
      2. 必要に応じてHostEnqueueFinalizationRegistryCleanupJob(fg)を実行する。
    3. map.[[WeakMapData]]に、r.[[Key]]valueであるRecord rを含むWeakMap mapそれぞれについて、次を行う
      1. r.[[Key]]emptyに設定する。
      2. r.[[Value]]emptyに設定する。
    4. set.[[WeakSetData]]valueを含むWeakSet setそれぞれについて、次を行う
      1. set.[[WeakSetData]]内の値がvalueである要素を、値がemptyである要素に置き換える。
注1

ライブネスの定義と合わせて、この節はWeakRefに関する実装最適化を規定します。

オブジェクトの識別性を観測せずにアクセスすることは可能です。逃避しないオブジェクトのプロパティへのスカラ置換やデッドバリアブル除去など、識別性が観測されない場合の最適化は許されます。従って、そのようなオブジェクトを指すWeakRefが観測的に空になることは許されます。

一方、オブジェクトの識別性が観測され、そのオブジェクトがWeakRef[[WeakRefTarget]]内部スロットにある場合、観測的にWeakRefを空にするような再素材化などの最適化は許されません。

HostEnqueueFinalizationRegistryCleanupJobの呼び出しは任意であるため、FinalizationRegistryに登録されたオブジェクトは必ずしもそのFinalizationRegistryライブにするとは限りません。たとえばFinalizationRegistry自身が死んだ場合や、アプリケーションがシャットダウン中の場合など、どのような理由でもコールバックを省略できます。

注2

実装は、非ライブなオブジェクトやシンボルの極大集合すべてについてWeakRefを空にする義務はありません。

実装がライブでない集合Sを選んでWeakRefを空にする場合、この定義はS内のすべての値に対するWeakRefを同時に空にすることを要求します。つまり、実装がvを指すWeakRefだけを空にし、他のWeakRefは空にせず、その結果vの値が観測される可能性があるような実行が可能になる場合、それは非準拠です。

9.9.4 ホストフック

9.9.4.1 HostEnqueueFinalizationRegistryCleanupJob ( finalizationRegistry )

ホスト定義抽象操作HostEnqueueFinalizationRegistryCleanupJobは、引数finalizationRegistryFinalizationRegistry)を取り、unusedを返します。

cleanupJobを、引数を取らずfinalizationRegistryをキャプチャし、呼び出されたときに次の手順を実行する新たなJob抽象クロージャとします:

  1. cleanupResultCompletion(CleanupFinalizationRegistry(finalizationRegistry))とする。
  2. もしcleanupResultabrupt completionであれば、エラー報告のためのホスト定義の手順を実行する。
  3. unusedを返す。

HostEnqueueFinalizationRegistryCleanupJobの実装は、可能であればcleanupJobを将来のある時点で実行されるようスケジューリングします。また、9.5の要件にも準拠しなければなりません。

9.10 ClearKeptObjects ( )

抽象操作ClearKeptObjectsは引数を取らず、unusedを返します。ECMAScript実装は、ECMAScriptの同期的な実行列が完了した際にClearKeptObjectsを呼び出すことが期待されています。呼び出されたとき、次の手順を実行します:

  1. agentRecord周囲のエージェントエージェントレコードとする。
  2. agentRecord.[[KeptAlive]]を新たな空のListに設定する。
  3. unusedを返す。

9.11 AddToKeptObjects ( value )

抽象操作AddToKeptObjectsは引数value(オブジェクトまたはシンボル)を取り、unusedを返します。呼び出されたとき、次の手順を実行します:

  1. agentRecord周囲のエージェントエージェントレコードとする。
  2. valueagentRecord.[[KeptAlive]]に追加する。
  3. unusedを返す。
AddToKeptObjects抽象操作が対象のオブジェクトまたはシンボルで呼び出されると、その対象を、ClearKeptObjectsが呼ばれるまで強参照で保持するリストに追加します。

9.12 CleanupFinalizationRegistry ( finalizationRegistry )

抽象操作CleanupFinalizationRegistryは引数finalizationRegistryFinalizationRegistry)を取り、normal completion containingunusedまたはthrow completionのいずれかを返します。呼び出されたとき、次の手順を実行します:

  1. 保証finalizationRegistry[[Cells]]および[[CleanupCallback]]内部スロットを持つ。
  2. callbackfinalizationRegistry.[[CleanupCallback]]とする。
  3. finalizationRegistry.[[Cells]]に、cell.[[WeakRefTarget]]emptyであるRecord cellが含まれている間、実装は次の手順を実行してもよい:
    1. そのようなcellを任意に選択する。
    2. cellfinalizationRegistry.[[Cells]]から削除する。
    3. ? HostCallJobCallback(callback, undefined, « cell.[[HeldValue]] » ) を実行する。
  4. unusedを返す。

9.13 CanBeHeldWeakly ( v )

抽象操作CanBeHeldWeaklyは引数vECMAScript言語値)を取り、Booleanを返します。vが弱参照として使用できる場合にのみtrueを返します。弱参照として使用できる値のみが、WeakMapのキー、WeakSetの要素、WeakRefのターゲット、またはFinalizationRegistryのターゲットのいずれかとなることができます。呼び出されたとき、次の手順を実行します:

  1. もしvオブジェクトであるなら、trueを返す。
  2. もしvシンボルであるかつKeyForSymbol(v)がundefinedであるなら、trueを返す。
  3. falseを返す。

言語識別性を持たない言語値は、事前の参照なしに現れることができ、弱参照として使用するのには適しません。Symbol.forで生成されたシンボル値は他のシンボル値と異なり、言語識別性を持たないため、弱参照として使用できません。ウェルノウンシンボルは通常ガベージコレクトされませんが、個数が限られておりさまざまな実装方法で管理可能であるため、弱参照として使用可能と見なされます。ただし、ライブなWeakMap内のウェルノウンシンボルに関連付けられた値はガベージコレクトされにくく、実装によってはメモリリソースが「リーク」する可能性があります。

10 通常オブジェクトおよびエキゾチックオブジェクトの挙動

10.1 通常オブジェクトの内部メソッドと内部スロット

すべての通常オブジェクト[[Prototype]]という内部スロットを持ちます。この内部スロットの値はnullまたはオブジェクトであり、継承の実装に使用されます。プロパティ名P通常オブジェクトOには存在しないが、その[[Prototype]]オブジェクトには存在する場合を考えます。P[[Prototype]]オブジェクト上のデータプロパティを指す場合、Oはそれをgetアクセスのために継承し、あたかもPOのプロパティであるかのようにふるまいます。P[[Prototype]]オブジェクト上の書き込み可能なデータプロパティを指す場合、O上でのPへのsetアクセスは、O上にPという名の新しいデータプロパティを作成します。P[[Prototype]]オブジェクト上の書き込み不可のデータプロパティを指す場合、O上でのPへのsetアクセスは失敗します。P[[Prototype]]オブジェクト上のアクセサプロパティを指す場合、そのアクセサはOによってgetアクセス・setアクセスの両方で継承されます。

すべての通常オブジェクトは、Boolean値を持つ[[Extensible]]内部スロットを持ち、これは6.1.7.3で規定される拡張性関連の内部メソッド不変条件を満たすために用いられます。すなわち、オブジェクトの[[Extensible]]内部スロットの値がfalseに設定されると、そのオブジェクトにプロパティを追加したり、オブジェクトの[[Prototype]]内部スロットの値を変更したり、[[Extensible]]を再びtrueに変更することはできなくなります。

以下のアルゴリズム記述では、O通常オブジェクトPプロパティキー値、Vは任意のECMAScript言語値Descプロパティディスクリプタレコードとします。

通常オブジェクトの内部メソッドは、同名の抽象操作に委譲されます。そのような抽象操作が他の内部メソッドに依存している場合、直接抽象操作を呼び出すのではなく、O上でその内部メソッドが呼び出されます。このセマンティクスによって、エキゾチックオブジェクト通常オブジェクトの内部メソッドを適用された際に、それらのオーバーライドされた内部メソッドが呼び出されることが保証されます。

10.1.1 [[GetPrototypeOf]] ( )

通常オブジェクトO[[GetPrototypeOf]]内部メソッドは引数を取らず、オブジェクトまたはnullを含むnormal completionを返します。呼び出されたとき、次の手順を実行します:

  1. OrdinaryGetPrototypeOf(O)を返す。

10.1.1.1 OrdinaryGetPrototypeOf ( O )

抽象操作OrdinaryGetPrototypeOfは引数O(オブジェクト)を取り、オブジェクトまたはnullを返します。呼び出されたとき、次の手順を実行します:

  1. O.[[Prototype]]を返す。

10.1.2 [[SetPrototypeOf]] ( V )

通常オブジェクトO[[SetPrototypeOf]]内部メソッドは引数V(オブジェクトまたはnull)を取り、Booleanを含むnormal completionを返します。呼び出されたとき、次の手順を実行します:

  1. OrdinarySetPrototypeOf(O, V)を返す。

10.1.2.1 OrdinarySetPrototypeOf ( O, V )

抽象操作OrdinarySetPrototypeOfは引数O(オブジェクト)、V(オブジェクトまたはnull)を取り、Booleanを返します。呼び出されたとき、次の手順を実行します:

  1. currentO.[[Prototype]]とする。
  2. SameValue(V, current)がtrueなら、trueを返す。
  3. extensibleO.[[Extensible]]とする。
  4. extensiblefalseなら、falseを返す。
  5. pVとする。
  6. donefalseとする。
  7. 繰り返し、donefalseの間、
    1. pnullなら、
      1. donetrueを設定する。
    2. そうでなく、SameValue(p, O)がtrueなら、
      1. falseを返す。
    3. それ以外の場合、
      1. p.[[GetPrototypeOf]]通常オブジェクト10.1.1で定義された内部メソッドでない場合、donetrueを設定する。
      2. それ以外の場合、pp.[[Prototype]]を設定する。
  8. O.[[Prototype]]Vを設定する。
  9. trueを返す。

7のループは、[[GetPrototypeOf]]および[[SetPrototypeOf]]通常オブジェクト定義のみを使うオブジェクトのみから成るプロトタイプチェーンにサイクルが生じないことを保証します。

10.1.3 [[IsExtensible]] ( )

通常オブジェクトO[[IsExtensible]]内部メソッドは引数を取らず、Booleanを含むnormal completionを返します。呼び出されたとき、次の手順を実行します:

  1. OrdinaryIsExtensible(O)を返す。

10.1.3.1 OrdinaryIsExtensible ( O )

抽象操作OrdinaryIsExtensibleは引数O(オブジェクト)を取り、Booleanを返します。呼び出されたとき、次の手順を実行します:

  1. O.[[Extensible]]を返す。

10.1.4 [[PreventExtensions]] ( )

通常オブジェクトO[[PreventExtensions]]内部メソッドは引数を取らず、trueを含むnormal completionを返します。呼び出されたとき、次の手順を実行します:

  1. OrdinaryPreventExtensions(O)を返す。

10.1.4.1 OrdinaryPreventExtensions ( O )

抽象操作OrdinaryPreventExtensionsは引数O(オブジェクト)を取り、trueを返します。呼び出されたとき、次の手順を実行します:

  1. O.[[Extensible]]falseを設定する。
  2. trueを返す。

10.1.5 [[GetOwnProperty]] ( P )

通常オブジェクトO[[GetOwnProperty]]内部メソッドは引数Pプロパティキー)を取り、プロパティディスクリプタまたはundefinedを含むnormal completionを返します。呼び出されたとき、次の手順を実行します:

  1. OrdinaryGetOwnProperty(O, P)を返す。

10.1.5.1 OrdinaryGetOwnProperty ( O, P )

抽象操作OrdinaryGetOwnPropertyは引数O(オブジェクト)、Pプロパティキー)を取り、プロパティディスクリプタまたはundefinedを返します。呼び出されたとき、次の手順を実行します:

  1. OがキーPの独自プロパティを持たない場合、undefinedを返す。
  2. Dを新たなフィールドを持たないプロパティディスクリプタとして作成する。
  3. XをキーPを持つOの独自プロパティとする。
  4. Xデータプロパティであれば、
    1. D.[[Value]]X[[Value]]属性の値を設定する。
    2. D.[[Writable]]X[[Writable]]属性の値を設定する。
  5. そうでなければ、
    1. 保証Xアクセサプロパティである。
    2. D.[[Get]]X[[Get]]属性の値を設定する。
    3. D.[[Set]]X[[Set]]属性の値を設定する。
  6. D.[[Enumerable]]X[[Enumerable]]属性の値を設定する。
  7. D.[[Configurable]]X[[Configurable]]属性の値を設定する。
  8. Dを返す。

10.1.6 [[DefineOwnProperty]] ( P, Desc )

通常オブジェクトO[[DefineOwnProperty]]内部メソッドは引数Pプロパティキー)、Descプロパティディスクリプタ)を取り、Booleanを含むnormal completionまたはthrow completionを返します。呼び出されたとき、次の手順を実行します:

  1. ? OrdinaryDefineOwnProperty(O, P, Desc)を返す。

10.1.6.1 OrdinaryDefineOwnProperty ( O, P, Desc )

抽象操作OrdinaryDefineOwnPropertyは引数O(オブジェクト)、Pプロパティキー)、Descプロパティディスクリプタ)を取り、Booleanを含むnormal completionまたはthrow completionを返します。呼び出されたとき、次の手順を実行します:

  1. currentを? O.[[GetOwnProperty]](P)とする。
  2. extensibleを? IsExtensible(O)とする。
  3. ValidateAndApplyPropertyDescriptor(O, P, extensible, Desc, current)を返す。

10.1.6.2 IsCompatiblePropertyDescriptor ( Extensible, Desc, Current )

抽象操作IsCompatiblePropertyDescriptorは引数Extensible(Boolean)、Descプロパティディスクリプタ)、Currentプロパティディスクリプタまたはundefined)を取り、Booleanを返します。呼び出されたとき、次の手順を実行します:

  1. ValidateAndApplyPropertyDescriptor(undefined, "", Extensible, Desc, Current)を返す。

10.1.6.3 ValidateAndApplyPropertyDescriptor ( O, P, extensible, Desc, current )

抽象操作ValidateAndApplyPropertyDescriptorは、引数O(オブジェクトまたはundefined)、Pプロパティキー)、extensible(Boolean)、Descプロパティディスクリプタ)、currentプロパティディスクリプタまたはundefined)を取り、Booleanを返す。Descが指定されたextensibilityと現在のプロパティcurrentのもとで、不変条件を維持しつつ、オブジェクトのプロパティとして適用可能な場合に限り、trueを返す。そのような適用が可能であり、かつOundefinedでない場合、プロパティ名P(必要に応じて新規作成)に対して実際に適用される。呼び出されたとき、次の手順を実行する:

  1. 保証Pプロパティキーである。
  2. もしcurrentundefinedなら、
    1. もしextensiblefalseなら、falseを返す。
    2. もしOundefinedなら、trueを返す。
    3. もしIsAccessorDescriptor(Desc)がtrueなら、
      1. オブジェクトOPという名前の独自のアクセサプロパティを作成し、その[[Get]][[Set]][[Enumerable]][[Configurable]]属性を、Descにそのフィールドがあればその値、なければ属性のデフォルト値に設定する。
    4. それ以外の場合、
      1. オブジェクトOPという名前の独自のデータプロパティを作成し、その[[Value]][[Writable]][[Enumerable]][[Configurable]]属性を、Descにそのフィールドがあればその値、なければ属性のデフォルト値に設定する。
    5. trueを返す。
  3. 保証current全てのフィールドが埋められたプロパティディスクリプタである。
  4. もしDescがいかなるフィールドも持たないなら、trueを返す。
  5. もしcurrent.[[Configurable]]falseなら、
    1. もしDesc[[Configurable]]フィールドを持ち、かつDesc.[[Configurable]]trueなら、falseを返す。
    2. もしDesc[[Enumerable]]フィールドを持ち、かつDesc.[[Enumerable]]current.[[Enumerable]]と異なるなら、falseを返す。
    3. もしIsGenericDescriptor(Desc)がfalseかつIsAccessorDescriptor(Desc)がIsAccessorDescriptor(current)と異なるなら、falseを返す。
    4. もしIsAccessorDescriptor(current)がtrueなら、
      1. もしDesc[[Get]]フィールドを持ち、かつSameValue(Desc.[[Get]], current.[[Get]])がfalseなら、falseを返す。
      2. もしDesc[[Set]]フィールドを持ち、かつSameValue(Desc.[[Set]], current.[[Set]])がfalseなら、falseを返す。
    5. それ以外の場合、もしcurrent.[[Writable]]falseなら、
      1. もしDesc[[Writable]]フィールドを持ち、かつDesc.[[Writable]]trueなら、falseを返す。
      2. 注:SameValueは、他の手段で区別できるNaN値に対してもtrueを返す。ここで返すことで、Oの既存プロパティが変更されないことを保証する。
      3. もしDesc[[Value]]フィールドを持つなら、SameValue(Desc.[[Value]], current.[[Value]])を返す。
  6. もしOundefinedでないなら、
    1. もしIsDataDescriptor(current)がtrueかつIsAccessorDescriptor(Desc)がtrueなら、
      1. もしDesc[[Configurable]]フィールドを持つならconfigurableDesc.[[Configurable]]とし、なければcurrent.[[Configurable]]とする。
      2. もしDesc[[Enumerable]]フィールドを持つならenumerableDesc.[[Enumerable]]とし、なければcurrent.[[Enumerable]]とする。
      3. オブジェクトOPという名前のプロパティを、[[Configurable]]属性および[[Enumerable]]属性をそれぞれconfigurableおよびenumerableに、[[Get]]および[[Set]]属性をDescにそのフィールドがあればその値、なければ属性のデフォルト値に設定したアクセサプロパティで置き換える。
    2. それ以外で、IsAccessorDescriptor(current)がtrueかつIsDataDescriptor(Desc)がtrueなら、
      1. もしDesc[[Configurable]]フィールドを持つならconfigurableDesc.[[Configurable]]とし、なければcurrent.[[Configurable]]とする。
      2. もしDesc[[Enumerable]]フィールドを持つならenumerableDesc.[[Enumerable]]とし、なければcurrent.[[Enumerable]]とする。
      3. オブジェクトOPという名前のプロパティを、[[Configurable]]属性および[[Enumerable]]属性をそれぞれconfigurableおよびenumerableに、[[Value]]および[[Writable]]属性をDescにそのフィールドがあればその値、なければ属性のデフォルト値に設定したデータプロパティで置き換える。
    3. それ以外の場合、
      1. Descの各フィールドについて、オブジェクトOPという名前のプロパティの対応する属性にその値を設定する。
  7. trueを返す。

10.1.7 [[HasProperty]] ( P )

通常オブジェクト O[[HasProperty]] 内部メソッドは、引数 Pプロパティキー)を取り、normal completion containingなBooleanまたはthrow completionのいずれかを返す。呼び出されたとき、次の手順を実行する:

  1. Return ? OrdinaryHasProperty(O, P).

10.1.7.1 OrdinaryHasProperty ( O, P )

抽象操作 OrdinaryHasProperty は、引数 O(オブジェクト)と Pプロパティキー)を取り、normal completion containingなBooleanまたはthrow completionのいずれかを返す。呼び出されたとき、次の手順を実行する:

  1. hasOwn を ? O.[[GetOwnProperty]](P) とする。
  2. もし hasOwnundefined でなければ、true を返す。
  3. parent を ? O.[[GetPrototypeOf]]() とする。
  4. もし parentnull でなければ、
    1. Return ? parent.[[HasProperty]](P)。
  5. false を返す。

10.1.8 [[Get]] ( P, Receiver )

通常オブジェクト O[[Get]] 内部メソッドは、引数 Pプロパティキー)および ReceiverECMAScript言語値)を取り、normal completion containingECMAScript言語値またはthrow completionのいずれかを返す。呼び出されたとき、次の手順を実行する:

  1. Return ? OrdinaryGet(O, P, Receiver).

10.1.8.1 OrdinaryGet ( O, P, Receiver )

抽象操作 OrdinaryGet は、引数 O(オブジェクト)、Pプロパティキー)、ReceiverECMAScript言語値)を取り、normal completion containingECMAScript言語値またはthrow completionのいずれかを返す。呼び出されたとき、次の手順を実行する:

  1. desc を ? O.[[GetOwnProperty]](P) とする。
  2. もし descundefined なら、
    1. parent を ? O.[[GetPrototypeOf]]() とする。
    2. もし parentnull なら、undefined を返す。
    3. Return ? parent.[[Get]](P, Receiver)。
  3. もし IsDataDescriptor(desc) が true なら、desc.[[Value]] を返す。
  4. 保証IsAccessorDescriptor(desc) が true である。
  5. getterdesc.[[Get]] とする。
  6. もし getterundefined なら、undefined を返す。
  7. Return ? Call(getter, Receiver)。

10.1.9 [[Set]] ( P, V, Receiver )

通常オブジェクト O[[Set]] 内部メソッドは、引数 Pプロパティキー)、VECMAScript言語値)、ReceiverECMAScript言語値)を取り、normal completion containingなBooleanまたはthrow completionのいずれかを返す。呼び出されたとき、次の手順を実行する:

  1. Return ? OrdinarySet(O, P, V, Receiver).

10.1.9.1 OrdinarySet ( O, P, V, Receiver )

抽象操作 OrdinarySet は、引数 O(オブジェクト)、Pプロパティキー)、VECMAScript言語値)、ReceiverECMAScript言語値)を取り、normal completion containingなBooleanまたはthrow completionのいずれかを返す。呼び出されたとき、次の手順を実行する:

  1. ownDesc を ? O.[[GetOwnProperty]](P) とする。
  2. Return ? OrdinarySetWithOwnDescriptor(O, P, V, Receiver, ownDesc)。

10.1.9.2 OrdinarySetWithOwnDescriptor ( O, P, V, Receiver, ownDesc )

抽象操作 OrdinarySetWithOwnDescriptor は、引数 O(オブジェクト)、Pプロパティキー)、VECMAScript言語値)、ReceiverECMAScript言語値)、ownDescプロパティディスクリプタまたはundefined)を取り、normal completion containingなBooleanまたはthrow completionのいずれかを返す。呼び出されたとき、次の手順を実行する:

  1. もし ownDescundefined なら、
    1. parent を ? O.[[GetPrototypeOf]]() とする。
    2. もし parentnull でなければ、
      1. Return ? parent.[[Set]](P, V, Receiver)。
    3. それ以外の場合、
      1. ownDesc を PropertyDescriptor { [[Value]]: undefined, [[Writable]]: true, [[Enumerable]]: true, [[Configurable]]: true } とする。
  2. もし IsDataDescriptor(ownDesc) が true なら、
    1. もし ownDesc.[[Writable]]false なら、false を返す。
    2. もし Receiver がオブジェクトでないなら、false を返す。
    3. existingDescriptor を ? Receiver.[[GetOwnProperty]](P) とする。
    4. もし existingDescriptorundefined でなければ、
      1. もし IsAccessorDescriptor(existingDescriptor) が true なら、false を返す。
      2. もし existingDescriptor.[[Writable]]false なら、false を返す。
      3. valueDesc を PropertyDescriptor { [[Value]]: V } とする。
      4. Return ? Receiver.[[DefineOwnProperty]](P, valueDesc)。
    5. それ以外の場合、
      1. 保証Receiverは現在プロパティPを持たない。
      2. Return ? CreateDataProperty(Receiver, P, V)。
  3. 保証IsAccessorDescriptor(ownDesc) が true である。
  4. setterownDesc.[[Set]] とする。
  5. もし setterundefined なら、false を返す。
  6. ? Call(setter, Receiver, « V ») を実行する。
  7. true を返す。

10.1.10 [[Delete]] ( P )

通常オブジェクト O[[Delete]] 内部メソッドは、引数 Pプロパティキー)を取り、normal completion containingなBooleanまたはthrow completionのいずれかを返す。呼び出されたとき、次の手順を実行する:

  1. Return ? OrdinaryDelete(O, P).

10.1.10.1 OrdinaryDelete ( O, P )

抽象操作 OrdinaryDelete は、引数 O(オブジェクト)、Pプロパティキー)を取り、normal completion containingなBooleanまたはthrow completionのいずれかを返す。呼び出されたとき、次の手順を実行する:

  1. desc を ? O.[[GetOwnProperty]](P) とする。
  2. もし descundefined なら、true を返す。
  3. もし desc.[[Configurable]]true なら、
    1. O から名前 P の独自プロパティを削除する。
    2. true を返す。
  4. false を返す。

10.1.11 [[OwnPropertyKeys]] ( )

通常オブジェクト O[[OwnPropertyKeys]] 内部メソッドは、引数を取らず、normal completion containingListプロパティキーのリスト)を返す。呼び出されたとき、次の手順を実行する:

  1. Return OrdinaryOwnPropertyKeys(O).

10.1.11.1 OrdinaryOwnPropertyKeys ( O )

抽象操作 OrdinaryOwnPropertyKeys は、引数 O(オブジェクト)を取り、Listプロパティキーのリスト)を返す。呼び出されたとき、次の手順を実行する:

  1. keys を新たな空の List とする。
  2. O の各独自プロパティキー P について、P配列インデックスである場合、昇順の数値インデックス順で、
    1. Pkeys に追加する。
  3. O の各独自プロパティキー P について、P文字列かつ配列インデックスでない場合、プロパティ作成の時系列で昇順に、
    1. Pkeys に追加する。
  4. O の各独自プロパティキー P について、Pシンボルである場合、プロパティ作成の時系列で昇順に、
    1. Pkeys に追加する。
  5. keys を返す。

10.1.12 OrdinaryObjectCreate ( proto [ , additionalInternalSlotsList ] )

抽象操作 OrdinaryObjectCreate は、引数 proto(オブジェクトまたは null)および省略可能な additionalInternalSlotsListList:内部スロット名のリスト)を取り、オブジェクトを返す。これは新しい 通常オブジェクト の実行時生成を指定するために使用される。additionalInternalSlotsList には、[[Prototype]] および [[Extensible]] 以外にオブジェクトの一部として定義されるべき追加の内部スロットの名前が含まれる。additionalInternalSlotsList が指定されていない場合、新たな空の List が使用される。呼び出されたとき、次の手順を実行する:

  1. internalSlotsList を « [[Prototype]], [[Extensible]] » とする。
  2. もし additionalInternalSlotsList が存在するなら、internalSlotsListリスト結合により internalSlotsListadditionalInternalSlotsList の連結結果に設定する。
  3. OMakeBasicObject(internalSlotsList) とする。
  4. O.[[Prototype]]proto に設定する。
  5. O を返す。

OrdinaryObjectCreate は MakeBasicObject を呼ぶ以外のことはほとんどしないが、その使用は 通常オブジェクト を作る意図を伝える。したがって、本仕様内では、オブジェクトの内部メソッドを変更して結果が通常でなくなるようなアルゴリズムによっては呼び出されない。エキゾチックオブジェクトを生成する操作は MakeBasicObject を直接呼び出す。

10.1.13 OrdinaryCreateFromConstructor ( constructor, intrinsicDefaultProto [ , internalSlotsList ] )

抽象操作 OrdinaryCreateFromConstructor は、引数 constructor関数オブジェクト)、intrinsicDefaultProto(文字列)、および省略可能な internalSlotsListList:内部スロット名のリスト)を取り、normal completion containingなオブジェクトまたはthrow completionのいずれかを返す。これは通常オブジェクトを生成し、その [[Prototype]] 値は constructor"prototype" プロパティから取得される(存在しない場合は intrinsicDefaultProto で指定されたインストリンシックが使われる)。internalSlotsList には、オブジェクトの一部として定義すべき追加の内部スロット名が含まれる。省略された場合、新たな空の List が使われる。呼び出されたとき、次の手順を実行する:

  1. 保証intrinsicDefaultProto はこの仕様のインストリンシックオブジェクト名であり、対応するオブジェクトはオブジェクトの [[Prototype]] 値として使用することを意図したインストリンシックでなければならない。
  2. proto を ? GetPrototypeFromConstructor(constructor, intrinsicDefaultProto) とする。
  3. もし internalSlotsList が存在するなら、slotsListinternalSlotsList とする。
  4. それ以外の場合、slotsList を新たな空の List とする。
  5. Return OrdinaryObjectCreate(proto, slotsList)。

10.1.14 GetPrototypeFromConstructor ( constructor, intrinsicDefaultProto )

抽象操作 GetPrototypeFromConstructor は、引数 constructor関数オブジェクト)、intrinsicDefaultProto(文字列)を取り、normal completion containingなオブジェクトまたはthrow completionのいずれかを返す。これは、特定のconstructorに対応するオブジェクトを生成する際に使うべき [[Prototype]] 値を判定する。値は constructor"prototype" プロパティから取得される。存在しない場合は intrinsicDefaultProto で指定されたインストリンシックが使われる。呼び出されたとき、次の手順を実行する:

  1. 保証intrinsicDefaultProto はこの仕様のインストリンシックオブジェクト名であり、対応するオブジェクトはオブジェクトの [[Prototype]] 値として使用することを意図したインストリンシックでなければならない。
  2. proto を ? Get(constructor, "prototype") とする。
  3. もし proto がオブジェクトでないなら、
    1. realm を ? GetFunctionRealm(constructor) とする。
    2. protorealmintrinsicDefaultProto という名前のインストリンシックオブジェクトに設定する。
  4. proto を返す。

constructor[[Prototype]] 値を提供しない場合、使用されるデフォルト値は constructor 関数の realm から取得され、実行中の実行コンテキストからは取得されない。

10.1.15 RequireInternalSlot ( O, internalSlot )

抽象操作RequireInternalSlotは、引数OECMAScript言語値)およびinternalSlot(内部スロット名)を取り、normal completion containingunusedまたはthrow completionのいずれかを返す。Oオブジェクトであり、かつ指定された内部スロットを持たない場合、例外をスローする。呼び出されたとき、次の手順を実行する:

  1. もしOオブジェクトでないなら、TypeError例外をスローする。
  2. もしOinternalSlot内部スロットを持たないなら、TypeError例外をスローする。
  3. unusedを返す。

10.2 ECMAScript関数オブジェクト

ECMAScriptの関数オブジェクトは、レキシカル環境に閉じたパラメータ付きのECMAScriptコードをカプセル化し、そのコードの動的な評価をサポートします。ECMAScriptの関数オブジェクト通常オブジェクトであり、他の通常オブジェクトと同じ内部スロットおよび内部メソッドを持ちます。ECMAScriptの関数オブジェクトのコードは、厳格モードコード11.2.2)または非厳格コードのいずれかです。ECMAScriptの関数オブジェクトで、そのコードが厳格モードコードであるものをstrict関数と呼びます。コードが厳格モードコードでないものをnon-strict関数と呼びます。

[[Extensible]]および[[Prototype]]に加え、ECMAScript関数オブジェクト表30に示す内部スロットも持ちます。

表30: ECMAScript関数オブジェクトの内部スロット
内部スロット 説明
[[Environment]] Environment Record この関数がクロージャしたEnvironment Record。関数のコードを評価する際の外部環境として使用される。
[[PrivateEnvironment]] PrivateEnvironment Record または null この関数がクロージャしたPrivateEnvironment RecordPrivate Name用)。この関数が構文的にクラス内に含まれていない場合はnull。関数のコードを評価する際の内部クラスの外部PrivateEnvironmentとして使用される。
[[FormalParameters]] Parse Node 関数の仮引数リストを定義するソーステキストのルート構文ノード。
[[ECMAScriptCode]] Parse Node 関数本体を定義するソーステキストのルート構文ノード。
[[ConstructorKind]] base または derived この関数が派生クラスのconstructorかどうか。
[[Realm]] Realm Record この関数が作成されたrealmであり、その評価時にアクセスされる内部オブジェクトを提供する。
[[ScriptOrModule]] Script Record または Module Record この関数が作成されたスクリプトまたはモジュール。
[[ThisMode]] lexical, strict, またはglobal 関数の仮引数および本体内でthis参照がどのように解釈されるかを定義する。lexicalthisがレキシカルに囲んでいる関数のthis値を参照することを意味する。strictは関数呼び出し時に与えられたthis値をそのまま使用する。globalundefinedまたはnullthis値をグローバルオブジェクトへの参照として解釈し、それ以外はToObjectに渡す。
[[Strict]] Boolean strict関数の場合はtruenon-strict関数の場合はfalse
[[HomeObject]] オブジェクト 関数がsuperを使用する場合、superプロパティ検索の起点となるオブジェクトの[[GetPrototypeOf]]を提供するオブジェクト。
[[SourceText]] Unicodeコードポイント列 関数を定義するソーステキスト
[[Fields]] ListClassFieldDefinition Recordのリスト) 関数がクラスである場合、クラスの非staticフィールドおよびそれに対応する初期化子を表すRecordのリスト。
[[PrivateMethods]] ListPrivateElementのリスト) 関数がクラスである場合、クラスの非staticなプライベートメソッドとアクセサを表すリスト。
[[ClassFieldInitializerName]] 文字列、シンボル、Private Name、またはempty 関数がクラスフィールドの初期化子として生成された場合、そのフィールドのNamedEvaluationに使用する名前。そうでなければempty
[[IsClassConstructor]] Boolean 関数がクラスのconstructorであるかどうかを示す(trueなら、関数の[[Call]]を呼び出すとただちにTypeError例外がスローされる)。

すべてのECMAScript関数オブジェクトは、ここで定義される[[Call]]内部メソッドを持っています。また、コンストラクタでもあるECMAScript関数は、さらに[[Construct]]内部メソッドも持ちます。

10.2.1 [[Call]] ( thisArgument, argumentsList )

ECMAScriptの関数オブジェクトF[[Call]]内部メソッドは、引数thisArgumentECMAScript言語値)およびargumentsListList(要素はECMAScript言語値))を取り、normal completion containingECMAScript言語値またはthrow completionのいずれかを返す。呼び出されたとき、次の手順を実行する:

  1. callerContext実行中の実行コンテキストとする。
  2. calleeContextPrepareForOrdinaryCall(F, undefined)とする。
  3. 保証calleeContextは現在実行中の実行コンテキストである。
  4. もしF.[[IsClassConstructor]]trueなら、
    1. errorを新しく生成したTypeErrorオブジェクトとする。
    2. 注:errorcalleeContext内で、Fに関連付けられたRealm Recordで作成される。
    3. calleeContext実行コンテキストスタックから除去し、callerContext実行中の実行コンテキストとして復元する。
    4. ThrowCompletion(error)を返す。
  5. OrdinaryCallBindThis(F, calleeContext, thisArgument)を実行する。
  6. resultCompletion(OrdinaryCallEvaluateBody(F, argumentsList))とする。
  7. calleeContext実行コンテキストスタックから除去し、callerContext実行中の実行コンテキストとして復元する。
  8. もしresultreturn completionなら、result.[[Value]]を返す。
  9. 保証resultthrow completionである。
  10. ? resultを返す。

ステップ7calleeContext実行コンテキストスタックから除去される際、そのコンテキストがサスペンドされ、アクセス可能なGeneratorによって後で再開されるために保持されているのであれば、破棄されてはならない。

10.2.1.1 PrepareForOrdinaryCall ( F, newTarget )

抽象操作PrepareForOrdinaryCallは、引数F(ECMAScript関数オブジェクト)、newTarget(オブジェクトまたはundefined)を取り、実行コンテキストを返す。呼び出されたとき、次の手順を実行する:

  1. callerContext実行中の実行コンテキストとする。
  2. calleeContextを新しいECMAScriptコード実行コンテキストとする。
  3. calleeContextのFunctionをFに設定する。
  4. calleeRealmF.[[Realm]]とする。
  5. calleeContextRealmcalleeRealmに設定する。
  6. calleeContextのScriptOrModuleをF.[[ScriptOrModule]]に設定する。
  7. localEnvNewFunctionEnvironment(F, newTarget)とする。
  8. calleeContextのLexicalEnvironmentをlocalEnvに設定する。
  9. calleeContextのVariableEnvironmentをlocalEnvに設定する。
  10. calleeContextのPrivateEnvironmentをF.[[PrivateEnvironment]]に設定する。
  11. もしcallerContextがすでにサスペンドされていなければ、callerContextをサスペンドする。
  12. calleeContext実行コンテキストスタックにプッシュする;calleeContextは現在の実行中の実行コンテキストである。
  13. 注:この時点以降に生成される例外オブジェクトはcalleeRealmに関連付けられる。
  14. calleeContextを返す。

10.2.1.2 OrdinaryCallBindThis ( F, calleeContext, thisArgument )

抽象操作OrdinaryCallBindThisは、引数F(ECMAScript関数オブジェクト)、calleeContext実行コンテキスト)、thisArgumentECMAScript言語値)を取り、unusedを返す。呼び出されたとき、次の手順を実行する:

  1. thisModeF.[[ThisMode]]とする。
  2. もしthisModelexicalなら、unusedを返す。
  3. calleeRealmF.[[Realm]]とする。
  4. localEnvcalleeContextのLexicalEnvironmentとする。
  5. もしthisModestrictなら、
    1. thisValuethisArgumentとする。
  6. それ以外の場合、
    1. もしthisArgumentundefinedまたはnullのいずれかなら、
      1. globalEnvcalleeRealm.[[GlobalEnv]]とする。
      2. 保証globalEnvグローバル環境レコードである。
      3. thisValueglobalEnv.[[GlobalThisValue]]とする。
    2. それ以外の場合、
      1. thisValueを! ToObject(thisArgument)とする。
      2. 注:ToObjectcalleeRealmを使ってラッパーオブジェクトを生成する。
  7. 保証localEnv関数環境レコードである。
  8. 保証:次のステップはlocalEnv.[[ThisBindingStatus]]initializedでないのでabrupt completionを返すことはない。
  9. ! BindThisValue(localEnv, thisValue)を実行する。
  10. unusedを返す。

10.2.1.3 ランタイムセマンティクス: EvaluateBody

構文指示操作EvaluateBodyは、引数functionObject(ECMAScript関数オブジェクト)、argumentsListList(要素はECMAScript言語値))を取り、return completionまたはthrow completionを返す。以下の生成規則ごとに定義される:

FunctionBody : FunctionStatementList
  1. ? EvaluateFunctionBody of FunctionBody を、引数functionObjectおよびargumentsListで呼び出して返す。
ConciseBody : ExpressionBody
  1. ? EvaluateConciseBody of ConciseBody を、引数functionObjectおよびargumentsListで呼び出して返す。
GeneratorBody : FunctionBody
  1. ? EvaluateGeneratorBody of GeneratorBody を、引数functionObjectおよびargumentsListで呼び出して返す。
AsyncGeneratorBody : FunctionBody
  1. ? EvaluateAsyncGeneratorBody of AsyncGeneratorBody を、引数functionObjectおよびargumentsListで呼び出して返す。
AsyncFunctionBody : FunctionBody
  1. ? EvaluateAsyncFunctionBody of AsyncFunctionBody を、引数functionObjectおよびargumentsListで呼び出して返す。
AsyncConciseBody : ExpressionBody
  1. ? EvaluateAsyncConciseBody of AsyncConciseBody を、引数functionObjectおよびargumentsListで呼び出して返す。
Initializer : = AssignmentExpression
  1. 保証argumentsListは空である。
  2. 保証functionObject.[[ClassFieldInitializerName]]emptyでない。
  3. もしIsAnonymousFunctionDefinition(AssignmentExpression)がtrueなら、
    1. valueを? NamedEvaluation of Initializer を、引数functionObject.[[ClassFieldInitializerName]]で呼び出して得る。
  4. それ以外の場合、
    1. rhsを? Evaluation of AssignmentExpression で呼び出して得る。
    2. valueを? GetValue(rhs)で得る。
  5. ReturnCompletion(value)を返す。

フィールド初期化子は関数境界を構成するが、FunctionDeclarationInstantiationを呼び出しても観測可能な効果はないため省略される。

ClassStaticBlockBody : ClassStaticBlockStatementList
  1. 保証argumentsListは空である。
  2. ? EvaluateClassStaticBlockBody of ClassStaticBlockBody を引数functionObjectで呼び出して返す。

10.2.1.4 OrdinaryCallEvaluateBody ( F, argumentsList )

抽象操作OrdinaryCallEvaluateBodyは引数F(ECMAScript関数オブジェクト)、argumentsListList(要素はECMAScript言語値))を取り、return completionまたはthrow completionを返す。呼び出されたとき、次の手順を実行する:

  1. ? EvaluateBody of F.[[ECMAScriptCode]] を、引数FおよびargumentsListで呼び出して返す。

10.2.2 [[Construct]] ( argumentsList, newTarget )

ECMAScriptの関数オブジェクトF[[Construct]]内部メソッドは、引数argumentsListList(要素はECMAScript言語値))、newTargetコンストラクタ)を取り、normal completion containingなオブジェクトまたはthrow completionを返す。呼び出されたとき、次の手順を実行する:

  1. callerContext実行中の実行コンテキストとする。
  2. kindF.[[ConstructorKind]]とする。
  3. もしkindbaseなら、
    1. thisArgumentを? OrdinaryCreateFromConstructor(newTarget, "%Object.prototype%")とする。
  4. calleeContextPrepareForOrdinaryCall(F, newTarget)とする。
  5. 保証calleeContextは現在実行中の実行コンテキストである。
  6. もしkindbaseなら、
    1. OrdinaryCallBindThis(F, calleeContext, thisArgument)を実行する。
    2. initializeResultCompletion(InitializeInstanceElements(thisArgument, F))とする。
    3. もしinitializeResultabrupt completionなら、
      1. calleeContext実行コンテキストスタックから除去し、callerContext実行中の実行コンテキストとして復元する。
      2. ? initializeResultを返す。
  7. constructorEnvcalleeContextのLexicalEnvironmentとする。
  8. resultCompletion(OrdinaryCallEvaluateBody(F, argumentsList))とする。
  9. calleeContext実行コンテキストスタックから除去し、callerContext実行中の実行コンテキストとして復元する。
  10. もしresultthrow completionなら、
    1. ? resultを返す。
  11. 保証resultreturn completionである。
  12. もしresult.[[Value]]オブジェクトであるなら、result.[[Value]]を返す。
  13. もしkindbaseなら、thisArgumentを返す。
  14. もしresult.[[Value]]undefinedでないなら、TypeError例外をスローする。
  15. thisBindingを? constructorEnv.GetThisBinding()とする。
  16. 保証thisBindingオブジェクトである
  17. thisBindingを返す。

10.2.3 OrdinaryFunctionCreate ( functionPrototype, sourceText, ParameterList, Body, thisMode, env, privateEnv )

抽象操作OrdinaryFunctionCreateは、引数functionPrototype(オブジェクト)、sourceText(Unicodeコードポイント列)、ParameterListParse Node)、BodyParse Node)、thisModelexical-thisまたはnon-lexical-this)、envEnvironment Record)、privateEnvPrivateEnvironment Recordまたはnull)を取り、ECMAScript関数オブジェクトを返す。この操作は、デフォルトの[[Call]]内部メソッドを持ち、[[Construct]]内部メソッドを持たない(ただしMakeConstructorなどの操作で後から追加される場合がある)新しい関数の実行時生成を規定するものである。sourceTextは生成される関数の構文定義のソーステキストである。呼び出されたとき、次の手順を実行する:

  1. internalSlotsList表30に示す内部スロットとする。
  2. FOrdinaryObjectCreate(functionPrototype, internalSlotsList)とする。
  3. F.[[Call]]10.2.1で規定される定義に設定する。
  4. F.[[SourceText]]sourceTextに設定する。
  5. F.[[FormalParameters]]ParameterListに設定する。
  6. F.[[ECMAScriptCode]]Bodyに設定する。
  7. StrictIsStrict(Body)とする。
  8. F.[[Strict]]Strictに設定する。
  9. もしthisModelexical-thisなら、F.[[ThisMode]]lexicalに設定する。
  10. それ以外でStricttrueなら、F.[[ThisMode]]strictに設定する。
  11. それ以外の場合、F.[[ThisMode]]globalに設定する。
  12. F.[[IsClassConstructor]]falseに設定する。
  13. F.[[Environment]]envに設定する。
  14. F.[[PrivateEnvironment]]privateEnvに設定する。
  15. F.[[ScriptOrModule]]GetActiveScriptOrModule()に設定する。
  16. F.[[Realm]]現在のRealm Recordに設定する。
  17. F.[[HomeObject]]undefinedに設定する。
  18. F.[[Fields]]を新たな空のListに設定する。
  19. F.[[PrivateMethods]]を新たな空のListに設定する。
  20. F.[[ClassFieldInitializerName]]emptyに設定する。
  21. lenExpectedArgumentCount of ParameterListとする。
  22. SetFunctionLength(F, len)を実行する。
  23. Fを返す。

10.2.4 AddRestrictedFunctionProperties ( F, realm )

抽象操作AddRestrictedFunctionPropertiesは、引数F関数オブジェクト)、realmRealm Record)を取り、unusedを返す。呼び出されたとき、次の手順を実行する:

  1. 保証realm.[[Intrinsics]].[[%ThrowTypeError%]]が存在し初期化されている。
  2. throwerrealm.[[Intrinsics]].[[%ThrowTypeError%]]とする。
  3. ! DefinePropertyOrThrow(F, "caller", PropertyDescriptor { [[Get]]: thrower, [[Set]]: thrower, [[Enumerable]]: false, [[Configurable]]: true }) を実行する。
  4. ! DefinePropertyOrThrow(F, "arguments", PropertyDescriptor { [[Get]]: thrower, [[Set]]: thrower, [[Enumerable]]: false, [[Configurable]]: true }) を実行する。
  5. unusedを返す。

10.2.4.1 %ThrowTypeError% ( )

この関数は%ThrowTypeError%固有オブジェクトである。

これは各realmごとに一度だけ定義される匿名の組み込み関数オブジェクトである。

呼び出されたとき、次の手順を実行する:

  1. TypeError例外をスローする。

この関数の[[Extensible]]内部スロットの値はfalseである。

この関数の"length"プロパティの属性は { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: false } である。

この関数の"name"プロパティの属性は { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: false } である。

10.2.5 MakeConstructor ( F [ , writablePrototype [ , prototype ] ] )

抽象操作MakeConstructorは、引数F(ECMAScript関数オブジェクトまたは組み込み関数オブジェクト)、省略可能なwritablePrototype(Boolean)、prototype(オブジェクト)を取り、unusedを返す。Fコンストラクタに変換する。呼び出されたとき、次の手順を実行する:

  1. もしFがECMAScript関数オブジェクトなら、
    1. 保証IsConstructor(F)はfalse
    2. 保証Fは拡張可能なオブジェクトであり、かつ"prototype"独自プロパティを持たない。
    3. F.[[Construct]]10.2.2で規定される定義に設定する。
  2. それ以外の場合、
    1. F.[[Construct]]10.3.2で規定される定義に設定する。
  3. F.[[ConstructorKind]]baseに設定する。
  4. もしwritablePrototypeが指定されていなければ、writablePrototypetrueに設定する。
  5. もしprototypeが指定されていなければ、
    1. prototypeOrdinaryObjectCreate(%Object.prototype%)に設定する。
    2. ! DefinePropertyOrThrow(prototype, "constructor", PropertyDescriptor { [[Value]]: F, [[Writable]]: writablePrototype, [[Enumerable]]: false, [[Configurable]]: true }) を実行する。
  6. ! DefinePropertyOrThrow(F, "prototype", PropertyDescriptor { [[Value]]: prototype, [[Writable]]: writablePrototype, [[Enumerable]]: false, [[Configurable]]: false }) を実行する。
  7. unusedを返す。

10.2.6 MakeClassConstructor ( F )

抽象操作MakeClassConstructorは、引数F(ECMAScript関数オブジェクト)を取り、unusedを返す。呼び出されたとき、次の手順を実行する:

  1. 保証F.[[IsClassConstructor]]falseである。
  2. F.[[IsClassConstructor]]trueに設定する。
  3. unusedを返す。

10.2.7 MakeMethod ( F, homeObject )

抽象操作MakeMethodは、引数F(ECMAScript関数オブジェクト)、homeObject(オブジェクト)を取り、unusedを返す。これはFをメソッドとして設定する。呼び出されたとき、次の手順を実行する:

  1. 保証homeObject通常オブジェクトである。
  2. F.[[HomeObject]]homeObjectに設定する。
  3. unusedを返す。

10.2.8 DefineMethodProperty ( homeObject, key, closure, enumerable )

抽象操作DefineMethodPropertyは、引数homeObject(オブジェクト)、keyプロパティキーまたはPrivate Name)、closure関数オブジェクト)、enumerable(Boolean)を取り、normal completion containingPrivateElementまたはunused、あるいはabrupt completionを返す。呼び出されたとき、次の手順を実行する:

  1. 保証homeObjectは通常かつ拡張可能なオブジェクトである。
  2. もしkeyPrivate Nameなら、
    1. PrivateElement { [[Key]]: key, [[Kind]]: method, [[Value]]: closure } を返す。
  3. それ以外の場合、
    1. descをPropertyDescriptor { [[Value]]: closure, [[Writable]]: true, [[Enumerable]]: enumerable, [[Configurable]]: true } とする。
    2. ? DefinePropertyOrThrow(homeObject, key, desc)を実行する。
    3. 注:DefinePropertyOrThrowabrupt completionを返すのは、クラスstaticメソッドでkey"prototype"の場合のみである。
    4. unusedを返す。

10.2.9 SetFunctionName ( F, name [ , prefix ] )

抽象操作SetFunctionNameは、引数F関数オブジェクト)、nameプロパティキーまたはPrivate Name)、省略可能なprefix(文字列)を取り、unusedを返す。これはF"name"プロパティを追加する。呼び出されたとき、次の手順を実行する:

  1. 保証Fは拡張可能なオブジェクトであり、"name"独自プロパティを持たない。
  2. もしnameシンボルであるなら、
    1. descriptionname[[Description]]値とする。
    2. もしdescriptionundefinedなら、nameを空文字列に設定する。
    3. それ以外の場合、name文字列連結"["description"]"を連結したものに設定する。
  3. それ以外でnamePrivate Nameなら、
    1. namename.[[Description]]に設定する。
  4. もしF[[InitialName]]内部スロットを持つなら、
    1. F.[[InitialName]]nameに設定する。
  5. もしprefixが指定されているなら、
    1. name文字列連結prefix、コード単位0x0020(SPACE)、nameを連結したものに設定する。
    2. もしF[[InitialName]]内部スロットを持つなら、
      1. (任意で)F.[[InitialName]]nameに設定してもよい。
  6. ! DefinePropertyOrThrow(F, "name", PropertyDescriptor { [[Value]]: name, [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: true }) を実行する。
  7. unusedを返す。

10.2.10 SetFunctionLength ( F, length )

抽象操作SetFunctionLengthは、引数F関数オブジェクト)、length(非負の整数または+∞)を取り、unusedを返す。これはF"length"プロパティを追加する。呼び出されたとき、次の手順を実行する:

  1. 保証Fは拡張可能なオブジェクトであり、"length"独自プロパティを持たない。
  2. ! DefinePropertyOrThrow(F, "length", PropertyDescriptor { [[Value]]: 𝔽(length), [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: true }) を実行する。
  3. unusedを返す。

10.2.11 FunctionDeclarationInstantiation ( func, argumentsList )

抽象操作FunctionDeclarationInstantiationは、引数func(ECMAScript関数オブジェクト)、argumentsListList(要素はECMAScript言語値))を取り、normal completion containingunusedまたはthrow completionを返す。func関数オブジェクトであり、その実行コンテキストが確立されつつある。

注1

ECMAScript関数の評価のために実行コンテキストが確立されるとき、新しい関数環境レコードが作成され、その環境レコード内で各仮引数の束縛がインスタンス化される。関数本体内の各宣言もインスタンス化される。もし関数の仮引数にデフォルト値初期化子が含まれていない場合、パラメータと本体宣言は同じ環境レコードでインスタンス化される。デフォルト値パラメータ初期化子が存在する場合は、本体宣言のための2つ目の環境レコードが作成される。仮引数と関数はFunctionDeclarationInstantiationの一部として初期化される。他の全ての束縛は関数本体の評価時に初期化される。

呼び出されたとき、次の手順を実行する:

  1. calleeContext実行中の実行コンテキストとする。
  2. codefunc.[[ECMAScriptCode]]とする。
  3. strictfunc.[[Strict]]とする。
  4. formalsfunc.[[FormalParameters]]とする。
  5. parameterNamesBoundNames of formalsとする。
  6. もしparameterNamesに重複があれば、hasDuplicatestrue、なければfalseとする。
  7. simpleParameterListIsSimpleParameterList of formalsとする。
  8. hasParameterExpressionsContainsExpression of formalsとする。
  9. varNamesVarDeclaredNames of codeとする。
  10. varDeclarationsVarScopedDeclarations of codeとする。
  11. lexicalNamesLexicallyDeclaredNames of codeとする。
  12. functionNamesを新しい空のListとする。
  13. functionsToInitializeを新しい空のListとする。
  14. varDeclarationsの各要素dについて、逆順で、以下を行う:
    1. もしdVariableDeclarationでもForBindingでもBindingIdentifierでもない場合、
      1. 保証dFunctionDeclarationGeneratorDeclarationAsyncFunctionDeclaration、またはAsyncGeneratorDeclarationのいずれかである。
      2. fnBoundNames of dの唯一の要素とする。
      3. もしfunctionNamesfnを含まないなら、
        1. fnfunctionNamesの先頭に挿入する。
        2. 注:同じ名前の関数宣言が複数ある場合、最後の宣言が使用される。
        3. dfunctionsToInitializeの先頭に挿入する。
  15. argumentsObjectNeededtrueとする。
  16. もしfunc.[[ThisMode]]lexicalなら、
    1. 注:アロー関数はargumentsオブジェクトを持たない。
    2. argumentsObjectNeededfalseに設定する。
  17. それ以外でparameterNames"arguments"を含む場合、
    1. argumentsObjectNeededfalseに設定する。
  18. それ以外でhasParameterExpressionsfalseの場合、
    1. もしfunctionNames"arguments"を含むかlexicalNames"arguments"を含むなら、
      1. argumentsObjectNeededfalseに設定する。
  19. もしstricttrueまたはhasParameterExpressionsfalseなら、
    1. 注:パラメータ用には1つの環境レコードだけが必要。strictモードコード内でのevalの呼び出しは、そのevalの外側で見える新しい束縛を作成できないため。
    2. envcalleeContextのLexicalEnvironmentとする。
  20. それ以外の場合、
    1. 注:仮引数リスト内のdirect eval呼び出しで作成される束縛がパラメータ宣言環境の外側になるよう、別の環境レコードが必要となる。
    2. calleeEnvcalleeContextのLexicalEnvironmentとする。
    3. envNewDeclarativeEnvironment(calleeEnv)とする。
    4. 保証calleeContextのVariableEnvironmentとcalleeEnvは同じ環境レコードである。
    5. calleeContextのLexicalEnvironmentをenvに設定する。
  21. parameterNamesの各文字列paramNameについて、以下を行う:
    1. alreadyDeclaredを! env.HasBinding(paramName)とする。
    2. 注:早期エラーにより、重複パラメータ名はパラメータデフォルト値やrestパラメータを持たない非厳格関数でのみ許される。
    3. もしalreadyDeclaredfalseなら、
      1. ! env.CreateMutableBinding(paramName, false)を実行する。
      2. もしhasDuplicatestrueなら、
        1. ! env.InitializeBinding(paramName, undefined)を実行する。
  22. もしargumentsObjectNeededtrueなら、
    1. もしstricttrueまたはsimpleParameterListfalseなら、
      1. aoCreateUnmappedArgumentsObject(argumentsList)とする。
    2. それ以外の場合、
      1. 注:マップドargumentsオブジェクトは、restパラメータやパラメータデフォルト値初期化子、分割代入パラメータを持たない非厳格関数でのみ提供される。
      2. aoCreateMappedArgumentsObject(func, formals, argumentsList, env)とする。
    3. もしstricttrueなら、
      1. ! env.CreateImmutableBinding("arguments", false)を実行する。
      2. 注:strictモードコードでは早期エラーにより、この束縛への代入は試みられないため、そのミュータビリティは観測できない。
    4. それ以外の場合、
      1. ! env.CreateMutableBinding("arguments", false)を実行する。
    5. ! env.InitializeBinding("arguments", ao)を実行する。
    6. parameterBindingslist-concatenation of parameterNamesと« "arguments" »とする。
  23. それ以外の場合、
    1. parameterBindingsparameterNamesとする。
  24. iteratorRecordCreateListIteratorRecord(argumentsList)とする。
  25. もしhasDuplicatestrueなら、
    1. usedEnvundefinedとする。
  26. それ以外の場合、
    1. usedEnvenvとする。
  27. 注:次のステップは、式位置でReturnCompletionを返すことはできない。なぜならそのようなcompletionはYieldExpressionの使用のみで発生しうるが、これは早期エラー規則(15.5.1, 15.6.1)によってパラメータリスト内で禁止されている。
  28. ? IteratorBindingInitialization of formals with arguments iteratorRecord and usedEnvを実行する。
  29. もしhasParameterExpressionsfalseなら、
    1. 注:パラメータとトップレベルvarのためには1つの環境レコードだけが必要。
    2. instantiatedVarNamesListparameterBindingsのコピーとする。
    3. varNamesの各要素nについて、
      1. もしinstantiatedVarNamesnを含まないなら、
        1. ninstantiatedVarNamesに追加する。
        2. ! env.CreateMutableBinding(n, false)を実行する。
        3. ! env.InitializeBinding(n, undefined)を実行する。
    4. varEnvenvとする。
  30. それ以外の場合、
    1. 注:仮引数リスト内の式で作成されるクロージャが関数本体の宣言を見ることができないよう、別の環境レコードが必要。
    2. varEnvNewDeclarativeEnvironment(env)とする。
    3. calleeContextのVariableEnvironmentをvarEnvに設定する。
    4. instantiatedVarNamesを新しい空のListとする。
    5. varNamesの各要素nについて、
      1. もしinstantiatedVarNamesnを含まないなら、
        1. ninstantiatedVarNamesに追加する。
        2. ! varEnv.CreateMutableBinding(n, false)を実行する。
        3. もしparameterBindingsnを含まないか、またはfunctionNamesnを含むなら、
          1. initialValueundefinedとする。
        4. それ以外の場合、
          1. initialValueを! env.GetBindingValue(n, false)とする。
        5. ! varEnv.InitializeBinding(n, initialValue)を実行する。
        6. 注:仮引数と同じ名前のvarは、初期状態で対応する初期化済みパラメータと同じ値を持つ。
  31. 注:付録B.3.2.1がこの地点で追加のステップを挿入する。
  32. もしstrictfalseなら、
    1. lexEnvNewDeclarativeEnvironment(varEnv)とする。
    2. 注:非厳格関数はトップレベルのレキシカル宣言のために別の環境レコードを使う。こうすることでdirect evalがevalコードで導入されたvarスコープ宣言が既存のトップレベルレキシカルスコープ宣言と衝突するかどうか判定できる。これはstrict関数では不要であり、strictなdirect evalは常に全ての宣言を新しい環境レコードに配置するためである。
  33. それ以外の場合、
    1. lexEnvvarEnvとする。
  34. calleeContextのLexicalEnvironmentをlexEnvに設定する。
  35. lexDeclarationsLexicallyScopedDeclarations of codeとする。
  36. lexDeclarationsの各要素dについて、以下を行う:
    1. 注:レキシカル宣言名は関数/ジェネレーター宣言、仮引数、var名と重複しない。レキシカル宣言名はここでインスタンス化されるが初期化はされない。
    2. BoundNames of dの各要素dnについて、
      1. もしIsConstantDeclaration of dtrueなら、
        1. ! lexEnv.CreateImmutableBinding(dn, true)を実行する。
      2. それ以外の場合、
        1. ! lexEnv.CreateMutableBinding(dn, false)を実行する。
  37. privateEnvcalleeContextのPrivateEnvironmentとする。
  38. functionsToInitializeの各Parse Nodefについて、
    1. fnBoundNames of fの唯一の要素とする。
    2. foInstantiateFunctionObject of f with arguments lexEnvprivateEnvとする。
    3. ! varEnv.SetMutableBinding(fn, fo, false)を実行する。
  39. unusedを返す。
注2

B.3.2は、ECMAScript 2015以前のWebブラウザ実装との後方互換性のために上記アルゴリズムへの拡張を提供する。

10.3 組み込み関数オブジェクト

組み込み関数オブジェクト通常オブジェクトであり、通常オブジェクトについて10.1で規定された要件を満たさなければならない。

すべての通常オブジェクトに要求される内部スロット(10.1参照)に加え、組み込み関数オブジェクトは次の内部スロットも持たなければならない:

  • [[Realm]]:関数が作成されたRealm Record。これはrealmを表す。
  • [[InitialName]]:関数の初期名となる文字列。20.2.3.5で使用される。

組み込み関数オブジェクト[[Prototype]]内部スロットの初期値は、特に指定がない限り%Function.prototype%である。

組み込み関数オブジェクトは、10.3.1の定義に準拠した[[Call]]内部メソッドを持たなければならない。

組み込み関数オブジェクトは、そのオブジェクトが“コンストラクタ”と記述されている場合、または本仕様のいずれかのアルゴリズムが明示的にその[[Construct]]内部メソッドを設定する場合に限り、[[Construct]]内部メソッドを持つ。そのような[[Construct]]内部メソッドは10.3.2の定義に準拠しなければならない。

実装は、本仕様で定義されていない追加の組み込み関数オブジェクトを提供してもよい。

10.3.1 [[Call]] ( thisArgument, argumentsList )

組み込み関数オブジェクトF[[Call]]内部メソッドは、引数thisArgumentECMAScript言語値)およびargumentsListList(要素はECMAScript言語値))を取り、normal completion containingECMAScript言語値またはthrow completionのいずれかを返す。呼び出されたとき、次の手順を実行する:

  1. ? BuiltinCallOrConstruct(F, thisArgument, argumentsList, undefined)を返す。

10.3.2 [[Construct]] ( argumentsList, newTarget )

組み込み関数オブジェクトF(このメソッドが存在する場合)の[[Construct]]内部メソッドは、引数argumentsListList(要素はECMAScript言語値))、newTargetコンストラクタ)を取り、normal completion containingなオブジェクトまたはthrow completionを返す。呼び出されたとき、次の手順を実行する:

  1. resultを? BuiltinCallOrConstruct(F, uninitialized, argumentsList, newTarget)とする。
  2. 保証resultオブジェクトである
  3. resultを返す。

10.3.3 BuiltinCallOrConstruct ( F, thisArgument, argumentsList, newTarget )

抽象操作BuiltinCallOrConstructは、引数F(組み込み関数オブジェクト)、thisArgumentECMAScript言語値またはuninitialized)、argumentsListList(要素はECMAScript言語値))、newTargetコンストラクタまたはundefined)を取り、normal completion containingECMAScript言語値またはthrow completionを返す。呼び出されたとき、次の手順を実行する:

  1. callerContext実行中の実行コンテキストとする。
  2. もしcallerContextがすでにサスペンドされていなければ、callerContextをサスペンドする。
  3. calleeContextを新しい実行コンテキストとする。
  4. calleeContextのFunctionをFに設定する。
  5. calleeRealmF.[[Realm]]とする。
  6. calleeContextRealmcalleeRealmに設定する。
  7. calleeContextのScriptOrModuleをnullに設定する。
  8. calleeContextに対して必要な実装依存の初期化を実行する。
  9. calleeContext実行コンテキストスタックにプッシュする;calleeContextは現在の実行中の実行コンテキストである。
  10. resultCompletion Recordとし、「Fを評価する」ことにより得られる。仕様で定めるように、thisArgumentuninitializedならthis値は初期化されない。それ以外の場合はthisArgumentthis値となる。argumentsListは指定されたパラメータを与え、newTargetはNewTarget値を与える。
  11. 注:Fが本ドキュメントで定義されている場合、「Fの仕様」とは、ステップあるいはその他の手段で規定されるその挙動である。
  12. calleeContext実行コンテキストスタックから除去し、callerContext実行中の実行コンテキストとして復元する。
  13. ? resultを返す。

calleeContext実行コンテキストスタックから除去される際、アクセス可能なGeneratorによってサスペンドされ再開のために保持されている場合は、破棄されてはならない。

10.3.4 CreateBuiltinFunction ( behaviour, length, name, additionalInternalSlotsList [ , realm [ , prototype [ , prefix ] ] ] )

抽象操作CreateBuiltinFunctionは、引数behaviourAbstract Closure、アルゴリズムステップの集合、または本仕様で与えられる関数の挙動の別の定義)、length(非負の整数または+∞)、nameプロパティキーまたはPrivate Name)、additionalInternalSlotsListList(内部スロット名))、省略可能なrealmRealm Record)、prototype(オブジェクトまたはnull)、prefix(文字列)を取り、組み込み関数オブジェクトを返す。additionalInternalSlotsListはそのオブジェクトの一部として定義すべき追加の内部スロット名を含む。この操作は組み込み関数オブジェクトを生成する。呼び出されたとき、次の手順を実行する:

  1. もしrealmが指定されていなければ、realm現在のRealm Recordに設定する。
  2. もしprototypeが指定されていなければ、prototyperealm.[[Intrinsics]].[[%Function.prototype%]]に設定する。
  3. internalSlotsListListとし、これから作成する組み込み関数オブジェクト10.3が要求するすべての内部スロット名を入れる。
  4. internalSlotsListadditionalInternalSlotsListの要素を追加する。
  5. funcを新しい組み込み関数オブジェクトとし、呼び出されたときbehaviourで規定された動作を、指定された引数をbehaviourで指定されたパラメータ値として用いて実行するものとする。新しい関数オブジェクトinternalSlotsListの名前を持つ内部スロットと、[[InitialName]]内部スロットを持つ。
  6. func.[[Prototype]]prototypeに設定する。
  7. func.[[Extensible]]trueに設定する。
  8. func.[[Realm]]realmに設定する。
  9. func.[[InitialName]]nullに設定する。
  10. SetFunctionLength(func, length)を実行する。
  11. もしprefixが指定されていなければ、
    1. SetFunctionName(func, name)を実行する。
  12. それ以外の場合、
    1. SetFunctionName(func, name, prefix)を実行する。
  13. funcを返す。

本仕様で定義される各組み込み関数は、CreateBuiltinFunction抽象操作の呼び出しにより生成される。

10.4 組み込みエキゾチックオブジェクトの内部メソッドとスロット

本仕様は複数の種類の組み込みエキゾチックオブジェクトを定義する。これらのオブジェクトは、特定の状況を除いて、一般的には通常オブジェクトと同様に振る舞う。以下のエキゾチックオブジェクトは、特に以下で明示的に規定されている場合を除き、通常オブジェクトの内部メソッドを使用する:

10.4.1 バウンド関数エキゾチックオブジェクト

バウンド関数エキゾチックオブジェクトは、別の関数オブジェクトをラップするエキゾチックオブジェクトである。バウンド関数エキゾチックオブジェクトは呼び出し可能([[Call]]内部メソッドを持ち、[[Construct]]内部メソッドを持つ場合もある)である。バウンド関数エキゾチックオブジェクトの呼び出しは、通常はラップされた関数の呼び出しとなる。

あるオブジェクトがバウンド関数エキゾチックオブジェクトであるのは、その[[Call]]および(該当する場合)[[Construct]]内部メソッドが以下の実装を用い、それ以外の必須内部メソッドが10.1で定義されているものを用いる場合である。これらのメソッドはBoundFunctionCreateで付与される。

バウンド関数エキゾチックオブジェクトは、表30に挙げられているECMAScript関数オブジェクトの内部スロットは持たない。代わりに[[Prototype]]および[[Extensible]]に加え、表31に挙げられている内部スロットを持つ。

表31: バウンド関数エキゾチックオブジェクトの内部スロット
内部スロット 説明
[[BoundTargetFunction]] 呼び出し可能オブジェクト ラップされている関数オブジェクト
[[BoundThis]] ECMAScript言語値 ラップされた関数を呼び出す際に常にthis値として渡される値。
[[BoundArguments]] List(要素はECMAScript言語値 ラップされた関数への呼び出しで最初の引数として使用される値のリスト。

10.4.1.1 [[Call]] ( thisArgument, argumentsList )

バウンド関数エキゾチックオブジェクトF[[Call]]内部メソッドは、引数thisArgumentECMAScript言語値)、argumentsListList(要素はECMAScript言語値))を取り、normal completion containingECMAScript言語値またはthrow completionのいずれかを返す。呼び出されたとき、次の手順を実行する:

  1. targetF.[[BoundTargetFunction]]とする。
  2. boundThisF.[[BoundThis]]とする。
  3. boundArgsF.[[BoundArguments]]とする。
  4. argslist-concatenation of boundArgsargumentsListとする。
  5. ? Call(target, boundThis, args)を返す。

10.4.1.2 [[Construct]] ( argumentsList, newTarget )

バウンド関数エキゾチックオブジェクトF[[Construct]]内部メソッドは、引数argumentsListList(要素はECMAScript言語値))、newTargetコンストラクタ)を取り、normal completion containingなオブジェクトまたはthrow completionを返す。呼び出されたとき、次の手順を実行する:

  1. targetF.[[BoundTargetFunction]]とする。
  2. 保証IsConstructor(target)はtrueである。
  3. boundArgsF.[[BoundArguments]]とする。
  4. argslist-concatenation of boundArgsargumentsListとする。
  5. もしSameValue(F, newTarget)がtrueなら、newTargettargetとする。
  6. ? Construct(target, args, newTarget)を返す。

10.4.1.3 BoundFunctionCreate ( targetFunction, boundThis, boundArgs )

抽象操作BoundFunctionCreateは、引数targetFunction関数オブジェクト)、boundThisECMAScript言語値)、boundArgsList(要素はECMAScript言語値))を取り、normal completion containing関数オブジェクトまたはthrow completionを返す。新しいバウンド関数エキゾチックオブジェクトの生成を規定する。呼び出されたとき、次の手順を実行する:

  1. protoを? targetFunction.[[GetPrototypeOf]]()とする。
  2. internalSlotsListlist-concatenation of « [[Prototype]], [[Extensible]] » および表31に挙げられている内部スロットとする。
  3. objMakeBasicObject(internalSlotsList)とする。
  4. obj.[[Prototype]]protoに設定する。
  5. obj.[[Call]]10.4.1.1で説明されるものに設定する。
  6. もしIsConstructor(targetFunction)がtrueなら、
    1. obj.[[Construct]]10.4.1.2で説明されるものに設定する。
  7. obj.[[BoundTargetFunction]]targetFunctionに設定する。
  8. obj.[[BoundThis]]boundThisに設定する。
  9. obj.[[BoundArguments]]boundArgsに設定する。
  10. objを返す。

10.4.2 配列エキゾチックオブジェクト

配列(Array)は、配列インデックスプロパティキー6.1.7参照)に特別な扱いをするエキゾチックオブジェクトである。プロパティ名配列インデックスであるプロパティは要素とも呼ばれる。すべての配列は、値が常に0以上の整数値(Number)で、その数学的値が232未満である"length"という非設定可能プロパティを持つ。"length"プロパティの値は、名前が配列インデックスであるすべての自身のプロパティ名よりも数値的に大きい;配列の自身のプロパティが作成または変更されるたびに、この不変条件を維持するために他のプロパティが必要に応じて調整される。具体的には、名前が配列インデックスである自身のプロパティが追加された場合、必要に応じて"length"プロパティの値はその配列インデックスの数値+1に変更される;また、"length"プロパティの値が変更された場合、新しいlength以上の値を持つ配列インデックス名の自身のすべてのプロパティが削除される。この制約は配列の自身のプロパティにのみ適用され、プロトタイプから継承される"length"配列インデックスプロパティには影響しない。

あるオブジェクトの[[DefineOwnProperty]]内部メソッドが以下の実装を使い、それ以外の必須内部メソッドが10.1で定義されているものを使う場合、そのオブジェクトは配列エキゾチックオブジェクト(単に「配列」)である。これらのメソッドはArrayCreateにより付与される。

10.4.2.1 [[DefineOwnProperty]] ( P, Desc )

配列エキゾチックオブジェクトA[[DefineOwnProperty]]内部メソッドは、引数Pプロパティキー)、Descプロパティディスクリプタ)を受け取り、normal completion containingなBooleanまたはthrow completionを返す。呼び出されたとき、次の手順を実行する:

  1. もしP"length"なら、
    1. ? ArraySetLength(A, Desc)を返す。
  2. それ以外でP配列インデックスなら、
    1. lengthDescOrdinaryGetOwnProperty(A, "length")とする。
    2. 保証lengthDescundefinedでない。
    3. 保証IsDataDescriptor(lengthDesc)はtrue
    4. 保証lengthDesc.[[Configurable]]false
    5. lengthlengthDesc.[[Value]]とする。
    6. 保証lengthは0以上の整数値(Number)である。
    7. indexを! ToUint32(P)とする。
    8. もしindexlengthかつlengthDesc.[[Writable]]falseなら、falseを返す。
    9. succeededを! OrdinaryDefineOwnProperty(A, P, Desc)とする。
    10. もしsucceededfalseなら、falseを返す。
    11. もしindexlengthなら、
      1. lengthDesc.[[Value]]index + 1𝔽に設定する。
      2. succeededを! OrdinaryDefineOwnProperty(A, "length", lengthDesc)とする。
      3. 保証succeededtrue
    12. trueを返す。
  3. ? OrdinaryDefineOwnProperty(A, P, Desc)を返す。

10.4.2.2 ArrayCreate ( length [ , proto ] )

抽象操作ArrayCreateは、引数length(0以上の整数)、省略可能なproto(オブジェクト)を取り、normal completion containing配列エキゾチックオブジェクトまたはthrow completionを返す。これは新しい配列の生成を規定する。呼び出されたとき、次の手順を実行する:

  1. もしlength > 232 - 1なら、RangeError例外をスローする。
  2. もしprotoが指定されていなければ、proto%Array.prototype%に設定する。
  3. AMakeBasicObject[[Prototype]], [[Extensible]] »)とする。
  4. A.[[Prototype]]protoに設定する。
  5. A.[[DefineOwnProperty]]10.4.2.1で規定されるものに設定する。
  6. ! OrdinaryDefineOwnProperty(A, "length", PropertyDescriptor { [[Value]]: 𝔽(length), [[Writable]]: true, [[Enumerable]]: false, [[Configurable]]: false }) を実行する。
  7. Aを返す。

10.4.2.3 ArraySpeciesCreate ( originalArray, length )

抽象操作ArraySpeciesCreateは、引数originalArray(オブジェクト)、length(0以上の整数)を取り、normal completion containingなオブジェクトまたはthrow completionを返す。これはoriginalArrayに由来するコンストラクタ関数を用いて新しい配列または類似オブジェクトを生成することを規定する。返されるオブジェクトが必ずしも配列であることは保証されない。呼び出されたとき、次の手順を実行する:

  1. isArrayを? IsArray(originalArray)とする。
  2. もしisArrayfalseなら、? ArrayCreate(length)を返す。
  3. Cを? Get(originalArray, "constructor")とする。
  4. もしIsConstructor(C)がtrueなら、
    1. thisRealm現在のRealm Recordとする。
    2. realmCを? GetFunctionRealm(C)とする。
    3. もしthisRealmrealmCが同じRealm Recordでないなら、
      1. もしSameValue(C, realmC.[[Intrinsics]].[[%Array%]])がtrueなら、Cundefinedに設定する。
  5. もしCオブジェクトであるなら、
    1. Cを? Get(C, %Symbol.species%)に設定する。
    2. もしCnullなら、Cundefinedに設定する。
  6. もしCundefinedなら、? ArrayCreate(length)を返す。
  7. もしIsConstructor(C)がfalseなら、TypeError例外をスローする。
  8. ? Construct(C, « 𝔽(length) »)を返す。

もしoriginalArrayが現在の実行中の実行コンテキストrealmとは異なるrealmの標準組み込みArrayコンストラクタを使って生成されていた場合、新しい配列は実行中の実行コンテキストrealmで生成される。この仕様は、歴史的にArray.prototypeメソッドがArraySpeciesCreateで定義されるようになったWebブラウザとの互換性を維持する。

10.4.2.4 ArraySetLength ( A, Desc )

抽象操作ArraySetLengthは、引数A(配列)、Descプロパティディスクリプタ)を取り、normal completion containingなBooleanまたはthrow completionを返す。呼び出されたとき、次の手順を実行する:

  1. もしDesc[[Value]]フィールドを持たないなら、
    1. ! OrdinaryDefineOwnProperty(A, "length", Desc)を返す。
  2. newLenDescDescのコピーとする。
  3. newLenを? ToUint32(Desc.[[Value]])とする。
  4. numberLenを? ToNumber(Desc.[[Value]])とする。
  5. もしSameValueZero(newLen, numberLen)がfalseなら、RangeError例外をスローする。
  6. newLenDesc.[[Value]]newLenに設定する。
  7. oldLenDescOrdinaryGetOwnProperty(A, "length")とする。
  8. 保証oldLenDescundefinedでない。
  9. 保証IsDataDescriptor(oldLenDesc)はtrue
  10. 保証oldLenDesc.[[Configurable]]falseである。
  11. oldLenoldLenDesc.[[Value]]とする。
  12. もしnewLenoldLenなら、
    1. ! OrdinaryDefineOwnProperty(A, "length", newLenDesc)を返す。
  13. もしoldLenDesc.[[Writable]]falseなら、falseを返す。
  14. もしnewLenDesc[[Writable]]フィールドを持たないかnewLenDesc.[[Writable]]trueなら、
    1. newWritabletrueとする。
  15. それ以外の場合、
    1. 注:[[Writable]]属性をfalseに設定するのは、要素の削除に失敗した場合に遅延される。
    2. newWritablefalseとする。
    3. newLenDesc.[[Writable]]trueに設定する。
  16. succeededを! OrdinaryDefineOwnProperty(A, "length", newLenDesc)とする。
  17. もしsucceededfalseなら、falseを返す。
  18. Aのすべての自身のプロパティキーPについて、P配列インデックスかつ! ToUint32(P) ≥ newLenであるものを降順で、以下を行う:
    1. deleteSucceededを! A.[[Delete]](P)とする。
    2. もしdeleteSucceededfalseなら、
      1. newLenDesc.[[Value]]を! ToUint32(P) + 1𝔽に設定する。
      2. もしnewWritablefalseなら、newLenDesc.[[Writable]]falseに設定する。
      3. ! OrdinaryDefineOwnProperty(A, "length", newLenDesc)を実行する。
      4. falseを返す。
  19. もしnewWritablefalseなら、
    1. succeededを! OrdinaryDefineOwnProperty(A, "length", PropertyDescriptor { [[Writable]]: false })とする。
    2. 保証succeededtrueである。
  20. trueを返す。

ステップ3および4では、Desc.[[Value]]がオブジェクトの場合、そのvalueOfメソッドが2回呼ばれる。これは第2版以降この仕様で定められているレガシーな挙動である。

10.4.3 文字列エキゾチックオブジェクト

Stringオブジェクトは、文字列値をカプセル化し、その文字列値の個々のコードユニット要素に対応する仮想の整数インデックス付きデータプロパティを公開するエキゾチックオブジェクトである。文字列エキゾチックオブジェクトは常に、カプセル化された文字列値の長さを値とするデータプロパティ "length" を持つ。コードユニットのデータプロパティ"length"プロパティは共に書き込み不可・設定不可である。

あるオブジェクトの[[GetOwnProperty]][[DefineOwnProperty]][[OwnPropertyKeys]]内部メソッドが以下の実装を使い、それ以外の必須内部メソッドが10.1で定義されているものを使う場合、そのオブジェクトは文字列エキゾチックオブジェクト(または単にStringオブジェクト)である。これらのメソッドはStringCreateによって付与される。

文字列エキゾチックオブジェクト通常オブジェクトと同じ内部スロットを持つ。また、[[StringData]]内部スロットを持つ。

10.4.3.1 [[GetOwnProperty]] ( P )

文字列エキゾチックオブジェクトS[[GetOwnProperty]]内部メソッドは、引数Pプロパティキー)を取り、normal completion containingプロパティディスクリプタまたはundefinedを返す。呼び出されたとき、次の手順を実行する:

  1. descOrdinaryGetOwnProperty(S, P)とする。
  2. もしdescundefinedでなければ、descを返す。
  3. StringGetOwnProperty(S, P)を返す。

10.4.3.2 [[DefineOwnProperty]] ( P, Desc )

文字列エキゾチックオブジェクトS[[DefineOwnProperty]]内部メソッドは、引数Pプロパティキー)、Descプロパティディスクリプタ)を取り、normal completion containingなBooleanを返す。呼び出されたとき、次の手順を実行する:

  1. stringDescStringGetOwnProperty(S, P)とする。
  2. もしstringDescundefinedでなければ、
    1. extensibleS.[[Extensible]]とする。
    2. IsCompatiblePropertyDescriptor(extensible, Desc, stringDesc)を返す。
  3. ! OrdinaryDefineOwnProperty(S, P, Desc)を返す。

10.4.3.3 [[OwnPropertyKeys]] ( )

文字列エキゾチックオブジェクトO[[OwnPropertyKeys]]内部メソッドは引数を取らず、normal completion containingList(要素はプロパティキー)を返す。呼び出されたとき、次の手順を実行する:

  1. keysを新しい空のListとする。
  2. strO.[[StringData]]とする。
  3. 保証str文字列である
  4. lenstrの長さとする。
  5. 0 ≤ i < len となる各整数iについて、昇順で:
    1. ! ToString(𝔽(i))をkeysに追加する。
  6. Oの自身のプロパティキーPについて、P配列インデックスかつ! ToIntegerOrInfinity(P) ≥ lenであるものを昇順で:
    1. Pkeysに追加する。
  7. Oの自身のプロパティキーPについて、P文字列であるかつP配列インデックスでないものを生成順に昇順で:
    1. Pkeysに追加する。
  8. Oの自身のプロパティキーPについて、Pシンボルであるものを生成順に昇順で:
    1. Pkeysに追加する。
  9. keysを返す。

10.4.3.4 StringCreate ( value, prototype )

抽象操作StringCreateは、引数value(文字列)、prototype(オブジェクト)を取り、文字列エキゾチックオブジェクトを返す。これは新しい文字列エキゾチックオブジェクトの生成を規定する。呼び出されたとき、次の手順を実行する:

  1. SMakeBasicObject[[Prototype]], [[Extensible]], [[StringData]] »)とする。
  2. S.[[Prototype]]prototypeに設定する。
  3. S.[[StringData]]valueに設定する。
  4. S.[[GetOwnProperty]]10.4.3.1で規定されるものに設定する。
  5. S.[[DefineOwnProperty]]10.4.3.2で規定されるものに設定する。
  6. S.[[OwnPropertyKeys]]10.4.3.3で規定されるものに設定する。
  7. lengthvalueの長さとする。
  8. ! DefinePropertyOrThrow(S, "length", PropertyDescriptor { [[Value]]: 𝔽(length), [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: false }) を実行する。
  9. Sを返す。

10.4.3.5 StringGetOwnProperty ( S, P )

抽象操作StringGetOwnPropertyは、引数S[[StringData]]内部スロットを持つオブジェクト)、Pプロパティキー)を取り、プロパティディスクリプタまたはundefinedを返す。呼び出されたとき、次の手順を実行する:

  1. もしP文字列でないなら、undefinedを返す。
  2. indexCanonicalNumericIndexString(P)とする。
  3. もしindex整数値(Number)でなければ、undefinedを返す。
  4. もしindex-0𝔽またはindex < -0𝔽なら、undefinedを返す。
  5. strS.[[StringData]]とする。
  6. 保証str文字列である
  7. lenstrの長さとする。
  8. もし(index) ≥ lenなら、undefinedを返す。
  9. resultStrstrsubstring(index)から(index)+1まで)とする。
  10. プロパティディスクリプタ{ [[Value]]: resultStr, [[Writable]]: false, [[Enumerable]]: true, [[Configurable]]: false }を返す。

10.4.4 Argumentsエキゾチックオブジェクト

ほとんどのECMAScript関数は、コードで利用可能なargumentsオブジェクトを生成する。関数定義の特性によって、そのargumentsオブジェクトは通常オブジェクトまたはargumentsエキゾチックオブジェクトのいずれかになる。argumentsエキゾチックオブジェクトは、エキゾチックオブジェクトであり、その配列インデックスプロパティは、関連付けられたECMAScript関数の呼び出しの仮引数束縛にマッピングされる。

オブジェクトが、ここで明示されていない内部メソッドについて10.1で定義されたものを使い、指定された内部メソッドについて以下の実装を使う場合、そのオブジェクトはargumentsエキゾチックオブジェクトである。これらのメソッドはCreateMappedArgumentsObjectで付与される。

注1

CreateUnmappedArgumentsObjectはこの節に含まれるが、これはargumentsエキゾチックオブジェクトではなく通常オブジェクトを生成する。

Argumentsエキゾチックオブジェクト通常オブジェクトと同じ内部スロットを持つ。さらに[[ParameterMap]]内部スロットを持つ。通常のargumentsオブジェクトも[[ParameterMap]]内部スロットを持つが、その値は常にundefinedである。通常のargumentsオブジェクトでは、このスロットはObject.prototype.toString20.1.3.6)によってのみ識別に利用される。

注2

argumentsエキゾチックオブジェクト整数インデックス付きデータプロパティのうち、その数値名が対応する関数オブジェクトの仮引数の数より小さいものは、初期状態では関数の実行コンテキスト内の対応する引数束縛と値を共有する。つまり、プロパティの値を変更すると、対応する引数束縛の値も変更され、その逆も同様である。この対応は、そのプロパティが削除されて再定義された場合や、アクセサープロパティに変更された場合に切れる。argumentsオブジェクトが通常オブジェクトである場合、プロパティの値は関数に渡された引数の単なるコピーであり、動的な連動はない。

注3

ParameterMapオブジェクトとそのプロパティ値は、argumentsオブジェクトと引数束縛の連動を規定するための仕組みとして用いられる。ParameterMapオブジェクトおよびそのプロパティ値となるオブジェクトは、ECMAScriptコードから直接観測できない。ECMAScript実装は、規定されたセマンティクスを実装するために実際にこれらのオブジェクトを生成・利用する必要はない。

注4

通常のargumentsオブジェクトは、アクセス時にTypeError例外をスローする非設定可能なアクセサープロパティ"callee"を定義する。"callee"プロパティは、argumentsエキゾチックオブジェクト(一部の非厳格関数でのみ生成される)ではより特別な意味を持つ。通常バリアントでこのプロパティを定義するのは、準拠ECMAScript実装によって他の方法で定義されないようにするためである。

注5

ECMAScript実装のargumentsエキゾチックオブジェクトには、歴史的にアクセサープロパティ"caller"が含まれていた。ECMAScript 2017より前は、通常のargumentsオブジェクトにもthrowing"caller"アクセサを定義することが仕様で要求されていたが、現在はこの拡張は不要となった。

10.4.4.1 [[GetOwnProperty]] ( P )

argumentsエキゾチックオブジェクトargs[[GetOwnProperty]]内部メソッドは、引数Pプロパティキー)を取り、normal completion containingプロパティディスクリプタまたはundefinedを返す。呼び出されたとき、次の手順を実行する:

  1. descOrdinaryGetOwnProperty(args, P)とする。
  2. もしdescundefinedなら、undefinedを返す。
  3. mapargs.[[ParameterMap]]とする。
  4. isMappedを! HasOwnProperty(map, P)とする。
  5. もしisMappedtrueなら、
    1. desc.[[Value]]を! Get(map, P)に設定する。
  6. descを返す。

10.4.4.2 [[DefineOwnProperty]] ( P, Desc )

argumentsエキゾチックオブジェクトargs[[DefineOwnProperty]]内部メソッドは、引数Pプロパティキー)、Descプロパティディスクリプタ)を取り、normal completion containingなBooleanを返す。呼び出されたとき、次の手順を実行する:

  1. mapargs.[[ParameterMap]]とする。
  2. isMappedを! HasOwnProperty(map, P)とする。
  3. newArgDescDescとする。
  4. もしisMappedtrueかつIsDataDescriptor(Desc)がtrueなら、
    1. もしDesc[[Value]]フィールドを持たず、Desc[[Writable]]フィールドを持ち、Desc.[[Writable]]falseなら、
      1. newArgDescDescのコピーとする。
      2. newArgDesc.[[Value]]を! Get(map, P)に設定する。
  5. allowedを! OrdinaryDefineOwnProperty(args, P, newArgDesc)とする。
  6. もしallowedfalseなら、falseを返す。
  7. もしisMappedtrueなら、
    1. もしIsAccessorDescriptor(Desc)がtrueなら、
      1. ! map.[[Delete]](P)を実行する。
    2. それ以外の場合、
      1. もしDesc[[Value]]フィールドを持つなら、
        1. 保証:argumentsオブジェクトでマッピングされる仮引数は常に書き込み可能なので、次のSetは必ず成功する。
        2. ! Set(map, P, Desc.[[Value]], false)を実行する。
      2. もしDesc[[Writable]]フィールドを持ち、Desc.[[Writable]]falseなら、
        1. ! map.[[Delete]](P)を実行する。
  8. trueを返す。

10.4.4.3 [[Get]] ( P, Receiver )

argumentsエキゾチックオブジェクトargs[[Get]]内部メソッドは、引数Pプロパティキー)、ReceiverECMAScript言語値)を取り、normal completion containingECMAScript言語値またはthrow completionを返す。呼び出されたとき、次の手順を実行する:

  1. mapargs.[[ParameterMap]]とする。
  2. isMappedを! HasOwnProperty(map, P)とする。
  3. もしisMappedfalseなら、
    1. ? OrdinaryGet(args, P, Receiver)を返す。
  4. それ以外の場合、
    1. 保証mapにはPの仮引数マッピングが含まれている。
    2. ! Get(map, P)を返す。

10.4.4.4 [[Set]] ( P, V, Receiver )

argumentsエキゾチックオブジェクトargs[[Set]]内部メソッドは、引数Pプロパティキー)、VECMAScript言語値)、ReceiverECMAScript言語値)を取り、normal completion containingなBooleanまたはthrow completionを返す。呼び出されたとき、次の手順を実行する:

  1. もしSameValue(args, Receiver)がfalseなら、
    1. isMappedfalseとする。
  2. それ以外の場合、
    1. mapargs.[[ParameterMap]]とする。
    2. isMappedを! HasOwnProperty(map, P)とする。
  3. もしisMappedtrueなら、
    1. 保証:argumentsオブジェクトでマッピングされる仮引数は常に書き込み可能なので、次のSetは必ず成功する。
    2. ! Set(map, P, V, false)を実行する。
  4. ? OrdinarySet(args, P, V, Receiver)を返す。

10.4.4.5 [[Delete]] ( P )

argumentsエキゾチックオブジェクトargs[[Delete]]内部メソッドは、引数Pプロパティキー)を取り、normal completion containingなBooleanまたはthrow completionを返す。呼び出されたとき、次の手順を実行する:

  1. mapargs.[[ParameterMap]]とする。
  2. isMappedを! HasOwnProperty(map, P)とする。
  3. resultを? OrdinaryDelete(args, P)とする。
  4. もしresulttrueかつisMappedtrueなら、
    1. ! map.[[Delete]](P)を実行する。
  5. resultを返す。

10.4.4.6 CreateUnmappedArgumentsObject ( argumentsList )

抽象操作CreateUnmappedArgumentsObjectは、引数argumentsListList(要素はECMAScript言語値))を取り、通常オブジェクトを返す。呼び出されたとき、次の手順を実行する:

  1. lenargumentsListの要素数とする。
  2. objOrdinaryObjectCreate(%Object.prototype%, « [[ParameterMap]] »)とする。
  3. obj.[[ParameterMap]]undefinedに設定する。
  4. ! DefinePropertyOrThrow(obj, "length", PropertyDescriptor { [[Value]]: 𝔽(len), [[Writable]]: true, [[Enumerable]]: false, [[Configurable]]: true }) を実行する。
  5. indexを0とする。
  6. 繰り返し、index < lenの間、
    1. valargumentsList[index]とする。
    2. ! CreateDataPropertyOrThrow(obj, ! ToString(𝔽(index)), val)を実行する。
    3. indexindex + 1に設定する。
  7. ! DefinePropertyOrThrow(obj, %Symbol.iterator%, PropertyDescriptor { [[Value]]: %Array.prototype.values%, [[Writable]]: true, [[Enumerable]]: false, [[Configurable]]: true }) を実行する。
  8. ! DefinePropertyOrThrow(obj, "callee", PropertyDescriptor { [[Get]]: %ThrowTypeError%, [[Set]]: %ThrowTypeError%, [[Enumerable]]: false, [[Configurable]]: false }) を実行する。
  9. objを返す。

10.4.4.7 CreateMappedArgumentsObject ( func, formals, argumentsList, env )

抽象操作CreateMappedArgumentsObjectは、引数func(オブジェクト)、formalsParse Node)、argumentsListList(要素はECMAScript言語値))、envEnvironment Record)を取り、argumentsエキゾチックオブジェクトを返す。呼び出されたとき、次の手順を実行する:

  1. 保証formalsはrestパラメータ、バインディングパターン、初期化子を含まない。ただし重複識別子は許可される。
  2. lenargumentsListの要素数とする。
  3. objMakeBasicObject[[Prototype]], [[Extensible]], [[ParameterMap]] »)とする。
  4. obj.[[GetOwnProperty]]10.4.4.1で規定されるものに設定する。
  5. obj.[[DefineOwnProperty]]10.4.4.2で規定されるものに設定する。
  6. obj.[[Get]]10.4.4.3で規定されるものに設定する。
  7. obj.[[Set]]10.4.4.4で規定されるものに設定する。
  8. obj.[[Delete]]10.4.4.5で規定されるものに設定する。
  9. obj.[[Prototype]]%Object.prototype%に設定する。
  10. mapOrdinaryObjectCreate(null)とする。
  11. obj.[[ParameterMap]]mapに設定する。
  12. parameterNamesBoundNames of formalsとする。
  13. numberOfParametersparameterNamesの要素数とする。
  14. indexを0とする。
  15. 繰り返し、index < lenの間、
    1. valargumentsList[index]とする。
    2. ! CreateDataPropertyOrThrow(obj, ! ToString(𝔽(index)), val)を実行する。
    3. indexindex + 1に設定する。
  16. ! DefinePropertyOrThrow(obj, "length", PropertyDescriptor { [[Value]]: 𝔽(len), [[Writable]]: true, [[Enumerable]]: false, [[Configurable]]: true }) を実行する。
  17. mappedNamesを新しい空のListとする。
  18. indexnumberOfParameters - 1に設定する。
  19. 繰り返し、index ≥ 0の間、
    1. nameparameterNames[index]とする。
    2. もしmappedNamesnameを含まないなら、
      1. namemappedNamesに追加する。
      2. もしindex < lenなら、
        1. gMakeArgGetter(name, env)とする。
        2. pMakeArgSetter(name, env)とする。
        3. ! map.[[DefineOwnProperty]](! ToString(𝔽(index)), PropertyDescriptor { [[Set]]: p, [[Get]]: g, [[Enumerable]]: false, [[Configurable]]: true }) を実行する。
    3. indexindex - 1に設定する。
  20. ! DefinePropertyOrThrow(obj, %Symbol.iterator%, PropertyDescriptor { [[Value]]: %Array.prototype.values%, [[Writable]]: true, [[Enumerable]]: false, [[Configurable]]: true }) を実行する。
  21. ! DefinePropertyOrThrow(obj, "callee", PropertyDescriptor { [[Value]]: func, [[Writable]]: true, [[Enumerable]]: false, [[Configurable]]: true }) を実行する。
  22. objを返す。

10.4.4.7.1 MakeArgGetter ( name, env )

抽象操作MakeArgGetterは、引数name(文字列)、envEnvironment Record)を取り、関数オブジェクトを返す。これは、実行時にenv内のnameに束縛された値を返す組み込み関数オブジェクトを生成する。呼び出されたとき、次の手順を実行する:

  1. getterClosureを新しいAbstract Closure(パラメータなし、nameenvをキャプチャ)とし、呼び出されたとき次を行う:
    1. NormalCompletion(! env.GetBindingValue(name, false))を返す。
  2. getterCreateBuiltinFunction(getterClosure, 0, "", « »)とする。
  3. 注:getterはECMAScriptコードから直接アクセスされることはない。
  4. getterを返す。

10.4.4.7.2 MakeArgSetter ( name, env )

抽象操作MakeArgSetterは、引数name(文字列)、envEnvironment Record)を取り、関数オブジェクトを返す。これは、実行時にenv内のnameに値をセットする組み込み関数オブジェクトを生成する。呼び出されたとき、次の手順を実行する:

  1. setterClosureを新しいAbstract Closure(パラメータは(value)、nameenvをキャプチャ)とし、呼び出されたとき次を行う:
    1. NormalCompletion(! env.SetMutableBinding(name, value, false))を返す。
  2. setterCreateBuiltinFunction(setterClosure, 1, "", « »)とする。
  3. 注:setterはECMAScriptコードから直接アクセスされることはない。
  4. setterを返す。

10.4.5 TypedArray エキゾチックオブジェクト

TypedArrayは、正規数値文字列であるプロパティキーのうち、範囲内の整数インデックスを用いて同種要素にアクセスし、それ以外はプロトタイプチェーン探索無しで存在しないことを保証するという特殊な扱いを行うエキゾチックオブジェクトである。

任意の数値nについてToString(n)が正規数値文字列となるので、実装は実際に文字列変換を行わずにTypedArrayのプロパティキーとして数値を扱ってよい。

TypedArray通常オブジェクトと同じ内部スロットに加え、[[ViewedArrayBuffer]][[TypedArrayName]][[ContentType]][[ByteLength]][[ByteOffset]][[ArrayLength]]内部スロットを持つ。

オブジェクトの[[PreventExtensions]][[GetOwnProperty]][[HasProperty]][[DefineOwnProperty]][[Get]][[Set]][[Delete]][[OwnPropertyKeys]]内部メソッドがこの節の定義を、その他の本質的内部メソッドが10.1の定義を使う場合、そのオブジェクトはTypedArrayである。これらのメソッドはTypedArrayCreateにより付与される。

10.4.5.1 [[PreventExtensions]] ( )

TypedArrayO[[PreventExtensions]]内部メソッドは引数を取らず、normal completion containingなBooleanを返す。呼び出されたとき、次の手順を実行する:

  1. 注:6.1.7.3で規定される拡張性関連の不変条件により、このメソッドは、Oがプロパティを増やしたり(あるいは失ってから再度増やしたり)できる場合(基礎バッファがリサイズされるときの整数インデックス名のプロパティなど)、trueを返すことはできない。
  2. もしIsTypedArrayFixedLength(O)がfalseなら、falseを返す。
  3. OrdinaryPreventExtensions(O)を返す。

10.4.5.2 [[GetOwnProperty]] ( P )

TypedArrayO[[GetOwnProperty]]内部メソッドは、引数Pプロパティキー)を取り、normal completion containingプロパティディスクリプタまたはundefinedを返す。呼び出されたとき、次の手順を実行する:

  1. もしP文字列なら、
    1. numericIndexCanonicalNumericIndexString(P)とする。
    2. もしnumericIndexundefinedでなければ、
      1. valueTypedArrayGetElement(O, numericIndex)とする。
      2. もしvalueundefinedなら、undefinedを返す。
      3. プロパティディスクリプタ { [[Value]]: value, [[Writable]]: true, [[Enumerable]]: true, [[Configurable]]: true } を返す。
  2. OrdinaryGetOwnProperty(O, P)を返す。

10.4.5.3 [[HasProperty]] ( P )

TypedArrayO[[HasProperty]]内部メソッドは、引数Pプロパティキー)を取り、normal completion containingなBooleanまたはthrow completionを返す。呼び出されたとき、次の手順を実行する:

  1. もしP文字列なら、
    1. numericIndexCanonicalNumericIndexString(P)とする。
    2. もしnumericIndexundefinedでなければ、IsValidIntegerIndex(O, numericIndex)を返す。
  2. ? OrdinaryHasProperty(O, P)を返す。

10.4.5.4 [[DefineOwnProperty]] ( P, Desc )

TypedArrayO[[DefineOwnProperty]]内部メソッドは、引数Pプロパティキー)、Descプロパティディスクリプタ)を取り、normal completion containingなBooleanまたはthrow completionを返す。呼び出されたとき、次の手順を実行する:

  1. もしP文字列なら、
    1. numericIndexCanonicalNumericIndexString(P)とする。
    2. もしnumericIndexundefinedでなければ、
      1. もしIsValidIntegerIndex(O, numericIndex)がfalseなら、falseを返す。
      2. もしDesc[[Configurable]]フィールドを持ち、かつDesc.[[Configurable]]falseなら、falseを返す。
      3. もしDesc[[Enumerable]]フィールドを持ち、かつDesc.[[Enumerable]]falseなら、falseを返す。
      4. もしIsAccessorDescriptor(Desc)がtrueなら、falseを返す。
      5. もしDesc[[Writable]]フィールドを持ち、かつDesc.[[Writable]]falseなら、falseを返す。
      6. もしDesc[[Value]]フィールドを持つなら、? TypedArraySetElement(O, numericIndex, Desc.[[Value]])を実行する。
      7. trueを返す。
  2. ! OrdinaryDefineOwnProperty(O, P, Desc)を返す。

10.4.5.5 [[Get]] ( P, Receiver )

TypedArrayO[[Get]]内部メソッドは、引数Pプロパティキー)、ReceiverECMAScript言語値)を取り、normal completion containingECMAScript言語値またはthrow completionを返す。呼び出されたとき、次の手順を実行する:

  1. もしP文字列なら、
    1. numericIndexCanonicalNumericIndexString(P)とする。
    2. もしnumericIndexundefinedでなければ、
      1. TypedArrayGetElement(O, numericIndex)を返す。
  2. ? OrdinaryGet(O, P, Receiver)を返す。

10.4.5.6 [[Set]] ( P, V, Receiver )

TypedArrayO[[Set]]内部メソッドは、引数Pプロパティキー)、VECMAScript言語値)、ReceiverECMAScript言語値)を取り、normal completion containingなBooleanまたはthrow completionを返す。呼び出されたとき、次の手順を実行する:

  1. もしP文字列なら、
    1. numericIndexCanonicalNumericIndexString(P)とする。
    2. もしnumericIndexundefinedでなければ、
      1. もしSameValue(O, Receiver)がtrueなら、
        1. ? TypedArraySetElement(O, numericIndex, V)を実行する。
        2. trueを返す。
      2. もしIsValidIntegerIndex(O, numericIndex)がfalseなら、trueを返す。
  2. ? OrdinarySet(O, P, V, Receiver)を返す。

10.4.5.7 [[Delete]] ( P )

TypedArrayO[[Delete]]内部メソッドは、引数Pプロパティキー)を取り、normal completion containingなBooleanを返す。呼び出されたとき、次の手順を実行する:

  1. もしP文字列なら、
    1. numericIndexCanonicalNumericIndexString(P)とする。
    2. もしnumericIndexundefinedでなければ、
      1. もしIsValidIntegerIndex(O, numericIndex)がfalseならtrue、そうでなければfalseを返す。
  2. ! OrdinaryDelete(O, P)を返す。

10.4.5.8 [[OwnPropertyKeys]] ( )

TypedArrayO[[OwnPropertyKeys]]内部メソッドは引数を取らず、normal completion containingList(要素はプロパティキー)を返す。呼び出されたとき、次の手順を実行する:

  1. taRecordMakeTypedArrayWithBufferWitnessRecord(O, seq-cst)とする。
  2. keysを新しい空のListとする。
  3. もしIsTypedArrayOutOfBounds(taRecord)がfalseなら、
    1. lengthTypedArrayLength(taRecord)とする。
    2. 0 ≤ i < length となる各整数iについて、昇順で:
      1. ! ToString(𝔽(i))をkeysに追加する。
  4. Oの自身のプロパティキーPについて、P文字列かつP整数インデックスでないものを生成順に昇順で:
    1. Pkeysに追加する。
  5. Oの自身のプロパティキーPについて、Pシンボルであるものを生成順に昇順で:
    1. Pkeysに追加する。
  6. keysを返す。

10.4.5.9 バッファ証人レコード付きTypedArray

バッファ証人レコード付きTypedArrayは、Record値であり、TypedArrayと、参照しているバッファのキャッシュされたバイト長をカプセル化するためのものである。これは、参照バッファが拡張可能なSharedArrayBufferの場合に、バイト長データブロックのメモリ読み出しイベントが1回だけ共有されることを保証するために使われる。

バッファ証人レコード付きTypedArrayは、表32に示すフィールドを持つ。

表32: バッファ証人レコード付きTypedArray のフィールド
フィールド名 意味
[[Object]] TypedArray バッファのバイト長がロードされるTypedArray
[[CachedBufferByteLength]] 0以上の整数またはdetached Record生成時のオブジェクトの[[ViewedArrayBuffer]]のバイト長。

10.4.5.10 MakeTypedArrayWithBufferWitnessRecord ( obj, order )

抽象操作MakeTypedArrayWithBufferWitnessRecordは、引数objTypedArray)、orderseq-cstまたはunordered)を取り、バッファ証人レコード付きTypedArrayを返す。呼び出されたとき、次の手順を実行する:

  1. bufferobj.[[ViewedArrayBuffer]]とする。
  2. もしIsDetachedBuffer(buffer)がtrueなら、
    1. byteLengthdetachedとする。
  3. それ以外の場合、
    1. byteLengthArrayBufferByteLength(buffer, order)とする。
  4. バッファ証人レコード付きTypedArray { [[Object]]: obj, [[CachedBufferByteLength]]: byteLength }を返す。

10.4.5.11 TypedArrayCreate ( prototype )

抽象操作TypedArrayCreateは、引数prototype(オブジェクト)を取り、TypedArrayを返す。これは新しいTypedArraysの生成を規定する。呼び出されたとき、次の手順を実行する:

  1. internalSlotsListを« [[Prototype]], [[Extensible]], [[ViewedArrayBuffer]], [[TypedArrayName]], [[ContentType]], [[ByteLength]], [[ByteOffset]], [[ArrayLength]] »とする。
  2. AMakeBasicObject(internalSlotsList)とする。
  3. A.[[PreventExtensions]]10.4.5.1で規定されるものに設定する。
  4. A.[[GetOwnProperty]]10.4.5.2で規定されるものに設定する。
  5. A.[[HasProperty]]10.4.5.3で規定されるものに設定する。
  6. A.[[DefineOwnProperty]]10.4.5.4で規定されるものに設定する。
  7. A.[[Get]]10.4.5.5で規定されるものに設定する。
  8. A.[[Set]]10.4.5.6で規定されるものに設定する。
  9. A.[[Delete]]10.4.5.7で規定されるものに設定する。
  10. A.[[OwnPropertyKeys]]10.4.5.8で規定されるものに設定する。
  11. A.[[Prototype]]prototypeに設定する。
  12. Aを返す。

10.4.5.12 TypedArrayByteLength ( taRecord )

抽象操作TypedArrayByteLengthは、引数taRecordバッファ証人レコード付きTypedArray)を取り、0以上の整数を返す。呼び出されたとき、次の手順を実行する:

  1. もしIsTypedArrayOutOfBounds(taRecord)がtrueなら、0を返す。
  2. lengthTypedArrayLength(taRecord)とする。
  3. もしlength = 0 なら、0を返す。
  4. OtaRecord.[[Object]]とする。
  5. もしO.[[ByteLength]]autoでないなら、O.[[ByteLength]]を返す。
  6. elementSizeTypedArrayElementSize(O)とする。
  7. length × elementSizeを返す。

10.4.5.13 TypedArrayLength ( taRecord )

抽象操作TypedArrayLengthは、引数taRecordバッファ証人レコード付きTypedArray)を取り、0以上の整数を返す。呼び出されたとき、次の手順を実行する:

  1. 保証IsTypedArrayOutOfBounds(taRecord)はfalseである。
  2. OtaRecord.[[Object]]とする。
  3. もしO.[[ArrayLength]]autoでないなら、O.[[ArrayLength]]を返す。
  4. 保証IsFixedLengthArrayBuffer(O.[[ViewedArrayBuffer]])はfalseである。
  5. byteOffsetO.[[ByteOffset]]とする。
  6. elementSizeTypedArrayElementSize(O)とする。
  7. byteLengthtaRecord.[[CachedBufferByteLength]]とする。
  8. 保証byteLengthdetachedでない。
  9. floor((byteLength - byteOffset) / elementSize)を返す。

10.4.5.14 IsTypedArrayOutOfBounds ( taRecord )

抽象操作IsTypedArrayOutOfBoundsは、引数taRecordバッファ証人レコード付きTypedArray)を取り、Booleanを返す。これはオブジェクトの数値プロパティが基礎となるバッファの範囲外のインデックスを参照していないかどうかをチェックする。本操作は上流仕様のための便宜的なもの。呼び出されたとき、次の手順を実行する:

  1. OtaRecord.[[Object]]とする。
  2. bufferByteLengthtaRecord.[[CachedBufferByteLength]]とする。
  3. 保証IsDetachedBuffer(O.[[ViewedArrayBuffer]])がtrueとなるのはbufferByteLengthdetachedのとき、かつそのときだけである。
  4. もしbufferByteLengthdetachedなら、trueを返す。
  5. byteOffsetStartO.[[ByteOffset]]とする。
  6. もしO.[[ArrayLength]]autoなら、
    1. byteOffsetEndbufferByteLengthとする。
  7. それ以外の場合、
    1. elementSizeTypedArrayElementSize(O)とする。
    2. byteOffsetEndbyteOffsetStart + O.[[ArrayLength]] × elementSizeとする。
  8. もしbyteOffsetStart > bufferByteLength または byteOffsetEnd > bufferByteLengthなら、trueを返す。
  9. 注:長さ0のTypedArrayは範囲外とはみなされない。
  10. falseを返す。

10.4.5.15 IsTypedArrayFixedLength ( O )

抽象操作IsTypedArrayFixedLengthは、引数OTypedArray)を取り、Booleanを返す。呼び出されたとき、次の手順を実行する:

  1. もしO.[[ArrayLength]]autoなら、falseを返す。
  2. bufferO.[[ViewedArrayBuffer]]とする。
  3. もしIsFixedLengthArrayBuffer(buffer)がfalseかつIsSharedArrayBuffer(buffer)がfalseなら、falseを返す。
  4. trueを返す。

10.4.5.16 IsValidIntegerIndex ( O, index )

抽象操作IsValidIntegerIndexは、引数OTypedArray)、index(Number)を取り、Booleanを返す。呼び出されたとき、次の手順を実行する:

  1. もしIsDetachedBuffer(O.[[ViewedArrayBuffer]])がtrueなら、falseを返す。
  2. もしindex整数値(Number)でなければ、falseを返す。
  3. もしindex-0𝔽またはindex < -0𝔽なら、falseを返す。
  4. taRecordMakeTypedArrayWithBufferWitnessRecord(O, unordered)とする。
  5. 注:バッファが拡張可能なSharedArrayBufferの場合、境界チェックは同期化操作ではない。
  6. もしIsTypedArrayOutOfBounds(taRecord)がtrueなら、falseを返す。
  7. lengthTypedArrayLength(taRecord)とする。
  8. もし(index) ≥ lengthなら、falseを返す。
  9. trueを返す。

10.4.5.17 TypedArrayGetElement ( O, index )

抽象操作TypedArrayGetElementは、引数OTypedArray)、index(Number)を取り、Number, BigInt, またはundefinedを返す。呼び出されたとき、次の手順を実行する:

  1. もしIsValidIntegerIndex(O, index)がfalseなら、undefinedを返す。
  2. offsetO.[[ByteOffset]]とする。
  3. elementSizeTypedArrayElementSize(O)とする。
  4. byteIndexInBufferを((index) × elementSize) + offsetとする。
  5. elementTypeTypedArrayElementType(O)とする。
  6. GetValueFromBuffer(O.[[ViewedArrayBuffer]], byteIndexInBuffer, elementType, true, unordered)を返す。

10.4.5.18 TypedArraySetElement ( O, index, value )

抽象操作 TypedArraySetElement は、引数 OTypedArray)、index(Number)、および valueECMAScript 言語値)を取り、unused を含む normal completion または throw completion のいずれかを返す。この操作は呼び出されたとき、次の手順を実行する:

  1. もし O.[[ContentType]]bigint なら、numValue に ? ToBigInt(value) を設定する。
  2. それ以外の場合、numValue に ? ToNumber(value) を設定する。
  3. IsValidIntegerIndex(O, index) が true なら、
    1. offsetO.[[ByteOffset]] を設定する。
    2. elementSizeTypedArrayElementSize(O) を設定する。
    3. byteIndexInBuffer に ((index) × elementSize) + offset を設定する。
    4. elementTypeTypedArrayElementType(O) を設定する。
    5. SetValueInBuffer(O.[[ViewedArrayBuffer]], byteIndexInBuffer, elementType, numValue, true, unordered) を実行する。
  4. unused を返す。

この操作は常に成功したように見えるが、TypedArray の末尾を越えて書き込もうとした場合や、切り離された ArrayBuffer に支えられている TypedArray に対しては何の効果も持たない。

10.4.5.19 IsArrayBufferViewOutOfBounds ( O )

抽象操作 IsArrayBufferViewOutOfBounds は、引数 OTypedArray または DataView)を取り、Boolean を返す。この操作は、TypedArray の数値プロパティや DataView オブジェクトのメソッドのいずれかが、基礎となるデータブロックの範囲外のインデックスで値を参照できるかどうかを判定する。これは上流仕様の便宜のために存在する抽象操作である。呼び出されたとき、次の手順を実行する:

  1. もし O[[DataView]] 内部スロットを持つなら、
    1. viewRecordMakeDataViewWithBufferWitnessRecord(O, seq-cst) を設定する。
    2. IsViewOutOfBounds(viewRecord) を返す。
  2. taRecordMakeTypedArrayWithBufferWitnessRecord(O, seq-cst) を設定する。
  3. IsTypedArrayOutOfBounds(taRecord) を返す。

10.4.6 モジュール名前空間エキゾチックオブジェクト

モジュール名前空間エキゾチックオブジェクトは、 エキゾチックオブジェクトであり、 ECMAScript の Module からエクスポートされたバインディングを公開する(16.2.3を参照)。モジュール名前空間エキゾチックオブジェクトの String キー付き own プロパティと、Module によってエクスポートされたバインディング名との間には一対一の対応がある。エクスポートされたバインディングには export * によって間接的にエクスポートされたバインディングも含まれる。それぞれの String 値の own プロパティキーは、対応するエクスポートバインディング名の StringValue である。これらが モジュール名前空間エキゾチックオブジェクト の唯一の String キー付きプロパティである。それぞれのプロパティは属性 { [[Writable]]: true, [[Enumerable]]: true, [[Configurable]]: false } を持つ。 モジュール名前空間エキゾチックオブジェクト は拡張不可能である(not extensible)。

あるオブジェクトが モジュール名前空間エキゾチックオブジェクト であるとは、その [[GetPrototypeOf]][[SetPrototypeOf]][[IsExtensible]][[PreventExtensions]][[GetOwnProperty]][[DefineOwnProperty]][[HasProperty]][[Get]][[Set]][[Delete]][[OwnPropertyKeys]] 内部メソッドが本節の定義を使用し、それ以外の本質的な内部メソッドが 10.1 に定義されるものを使う場合である。これらのメソッドは ModuleNamespaceCreate によって組み込まれる。

モジュール名前空間エキゾチックオブジェクト は、 表 33 で定義される内部スロットを持つ。

表 33: モジュール名前空間エキゾチックオブジェクトの内部スロット
内部スロット 説明
[[Module]] Module Record この名前空間が公開するエクスポートを持つ Module Record
[[Exports]] String のリスト このオブジェクトの own プロパティとして公開されているエクスポート名の String 値の リスト。リストは 辞書式コードユニット順 でソートされている。

10.4.6.1 [[GetPrototypeOf]] ( )

モジュール名前空間エキゾチックオブジェクト[[GetPrototypeOf]] 内部メソッドは引数を取らず、値として null を含む normal completion を返す。呼び出されたとき、次の手順を実行する:

  1. null を返す。

10.4.6.2 [[SetPrototypeOf]] ( V )

モジュール名前空間エキゾチックオブジェクト O[[SetPrototypeOf]] 内部メソッドは引数 V(Object または null)を取り、値として Boolean を含む normal completion を返す。呼び出されたとき、次の手順を実行する:

  1. SetImmutablePrototype(O, V) を返す。

10.4.6.3 [[IsExtensible]] ( )

モジュール名前空間エキゾチックオブジェクト[[IsExtensible]] 内部メソッドは引数を取らず、値として false を含む normal completion を返す。呼び出されたとき、次の手順を実行する:

  1. false を返す。

10.4.6.4 [[PreventExtensions]] ( )

モジュール名前空間エキゾチックオブジェクト[[PreventExtensions]] 内部メソッドは引数を取らず、値として true を含む normal completion を返す。呼び出されたとき、次の手順を実行する:

  1. true を返す。

10.4.6.5 [[GetOwnProperty]] ( P )

モジュール名前空間エキゾチックオブジェクト O[[GetOwnProperty]] 内部メソッドは、引数 Pプロパティキー)を取り、normal completionProperty Descriptor または undefined を含む)、または throw completion を返す。呼び出されたとき、次の手順を実行する:

  1. もし PSymbol である場合、OrdinaryGetOwnProperty(O, P) を返す。
  2. exportsO.[[Exports]] とする。
  3. もし exportsP を含まない場合、undefined を返す。
  4. value を ? O.[[Get]](P, O) とする。
  5. PropertyDescriptor { [[Value]]: value, [[Writable]]: true, [[Enumerable]]: true, [[Configurable]]: false } を返す。

10.4.6.6 [[DefineOwnProperty]] ( P, Desc )

モジュール名前空間エキゾチックオブジェクト O[[DefineOwnProperty]] 内部メソッドは、引数 Pプロパティキー)および DescProperty Descriptor)を取り、normal completion(Boolean を含む)、または throw completion を返す。呼び出されたとき、次の手順を実行する:

  1. もし PSymbol である場合、! OrdinaryDefineOwnProperty(O, P, Desc) を返す。
  2. current を ? O.[[GetOwnProperty]](P) とする。
  3. もし currentundefined なら、false を返す。
  4. もし Desc[[Configurable]] フィールドを持ち、かつ Desc.[[Configurable]]true である場合、false を返す。
  5. もし Desc[[Enumerable]] フィールドを持ち、かつ Desc.[[Enumerable]]false である場合、false を返す。
  6. もし IsAccessorDescriptor(Desc) が true なら、false を返す。
  7. もし Desc[[Writable]] フィールドを持ち、かつ Desc.[[Writable]]false である場合、false を返す。
  8. もし Desc[[Value]] フィールドを持つなら、SameValue(Desc.[[Value]], current.[[Value]]) を返す。
  9. true を返す。

10.4.6.7 [[HasProperty]] ( P )

モジュール名前空間エキゾチックオブジェクト O[[HasProperty]] 内部メソッドは、引数 Pプロパティキー)を取り、値として Boolean を含む normal completion を返す。呼び出されたとき、次の手順を実行する:

  1. もし PSymbol である場合、! OrdinaryHasProperty(O, P) を返す。
  2. exportsO.[[Exports]] とする。
  3. もし exportsP を含む場合、true を返す。
  4. false を返す。

10.4.6.8 [[Get]] ( P, Receiver )

モジュール名前空間エキゾチックオブジェクト O[[Get]] 内部メソッドは、引数 Pプロパティキー)および ReceiverECMAScript 言語値)を取り、 normal completionECMAScript 言語値を含む)、または throw completion を返す。呼び出されたとき、次の手順を実行する:

  1. もし PSymbol である場合、
    1. OrdinaryGet(O, P, Receiver) を返す。
  2. exportsO.[[Exports]] とする。
  3. もし exportsP を含まない場合、undefined を返す。
  4. mO.[[Module]] とする。
  5. bindingm.ResolveExport(P) とする。
  6. アサートbindingResolvedBinding レコード である。
  7. targetModulebinding.[[Module]] とする。
  8. アサートtargetModuleundefined ではない。
  9. もし binding.[[BindingName]]namespace である場合、
    1. GetModuleNamespace(targetModule) を返す。
  10. targetEnvtargetModule.[[Environment]] とする。
  11. もし targetEnvempty である場合、ReferenceError 例外をスローする。
  12. targetEnv.GetBindingValue(binding.[[BindingName]], true) を返す。

ResolveExport は副作用を持たない。この操作が特定の exportNameresolveSet の組み合わせで呼ばれるたびに、常に同じ結果を返さなければならない。実装は各 [[Exports]] に対して ResolveExport の結果を事前計算・キャッシュしてもよい。モジュール名前空間エキゾチックオブジェクト のために。

10.4.6.9 [[Set]] ( P, V, Receiver )

モジュール名前空間エキゾチックオブジェクト[[Set]] 内部メソッドは、引数 Pプロパティキー)、VECMAScript 言語値)、ReceiverECMAScript 言語値)を取り、値として false を含む normal completion を返す。呼び出されたとき、次の手順を実行する:

  1. false を返す。

10.4.6.10 [[Delete]] ( P )

モジュール名前空間エキゾチックオブジェクト O[[Delete]] 内部メソッドは、引数 Pプロパティキー)を取り、値として Boolean を含む normal completion を返す。呼び出されたとき、次の手順を実行する:

  1. もし PSymbol である場合、
    1. OrdinaryDelete(O, P) を返す。
  2. exportsO.[[Exports]] とする。
  3. もし exportsP を含む場合、false を返す。
  4. true を返す。

10.4.6.11 [[OwnPropertyKeys]] ( )

モジュール名前空間エキゾチックオブジェクト O[[OwnPropertyKeys]] 内部メソッドは引数を取らず、normal completionリストプロパティキー)を含む)を返す。呼び出されたとき、次の手順を実行する:

  1. exportsO.[[Exports]] とする。
  2. symbolKeysOrdinaryOwnPropertyKeys(O) とする。
  3. リスト連結により exportssymbolKeys を結合したリストを返す。

10.4.6.12 ModuleNamespaceCreate ( module, exports )

抽象操作 ModuleNamespaceCreate は、引数 moduleModule Record)および exportsString のリスト)を取り、モジュール名前空間エキゾチックオブジェクト を返す。これは新しい モジュール名前空間エキゾチックオブジェクト の生成を指定するために用いられる。呼び出されたとき、次の手順を実行する:

  1. アサートmodule.[[Namespace]]empty である。
  2. internalSlotsList表 33 に記載されている内部スロットとする。
  3. MMakeBasicObject(internalSlotsList) とする。
  4. M の本質的な内部メソッドを 10.4.6 で指定された定義に設定する。
  5. M.[[Module]]module を設定する。
  6. sortedExportsリスト(要素は exports の要素を辞書式コードユニット順にソートしたもの)とする。
  7. M.[[Exports]]sortedExports を設定する。
  8. M の own プロパティを 28.3 の定義に対応して作成する。
  9. module.[[Namespace]]M を設定する。
  10. M を返す。

10.4.7 不変プロトタイプエキゾチックオブジェクト

不変プロトタイプエキゾチックオブジェクトは、 エキゾチックオブジェクトであり、初期化後は変更されない [[Prototype]] 内部スロットを持つ。

あるオブジェクトが 不変プロトタイプエキゾチックオブジェクト であるとは、その [[SetPrototypeOf]] 内部メソッドが以下の実装を用いる場合である(その他の本質的な内部メソッドは、対象の 不変プロトタイプエキゾチックオブジェクト に応じて任意の実装を用いてよい)。

他の エキゾチックオブジェクトとは異なり、不変プロトタイプエキゾチックオブジェクト専用の生成抽象操作は提供されていない。これは、これらが %Object.prototype%ホスト環境でのみ使用され、 ホスト環境では、該当オブジェクトが他の意味でもエキゾチックな場合があり、独自の生成操作が必要となるためである。

10.4.7.1 [[SetPrototypeOf]] ( V )

不変プロトタイプエキゾチックオブジェクト O[[SetPrototypeOf]] 内部メソッドは、引数 V(Object または null)を取り、normal completion(Boolean を含む)、または throw completion を返す。呼び出されたとき、次の手順を実行する:

  1. SetImmutablePrototype(O, V) を返す。

10.4.7.2 SetImmutablePrototype ( O, V )

抽象操作 SetImmutablePrototype は、引数 O(Object)、V(Object または null)を取り、normal completion(Boolean を含む)、または throw completion を返す。呼び出されたとき、次の手順を実行する:

  1. current を ? O.[[GetPrototypeOf]]() とする。
  2. SameValue(V, current) が true なら、true を返す。
  3. false を返す。

10.5 Proxy オブジェクトの内部メソッドおよび内部スロット

Proxy オブジェクトは、エキゾチックオブジェクトであり、その本質的な内部メソッドの一部が ECMAScript コードによって実装されている。すべての Proxy オブジェクトは [[ProxyHandler]] という内部スロットを持つ。[[ProxyHandler]] の値は、プロキシのハンドラーオブジェクトと呼ばれるオブジェクト、または null である。ハンドラーオブジェクトのメソッド(表 34参照)は、1つ以上の Proxy オブジェクトの内部メソッドの実装を拡張するために利用できる。すべての Proxy オブジェクトは [[ProxyTarget]] という内部スロットも持ち、その値はオブジェクトまたは null である。このオブジェクトはプロキシのターゲットオブジェクトと呼ばれる。

あるオブジェクトが Proxy エキゾチックオブジェクト であるとは、その本質的な内部メソッド(該当する場合は [[Call]] および [[Construct]] を含む)が本節の定義を使う場合である。これらの内部メソッドは ProxyCreate で設定される。

表 34: Proxy ハンドラーメソッド
内部メソッド ハンドラーメソッド
[[GetPrototypeOf]] getPrototypeOf
[[SetPrototypeOf]] setPrototypeOf
[[IsExtensible]] isExtensible
[[PreventExtensions]] preventExtensions
[[GetOwnProperty]] getOwnPropertyDescriptor
[[DefineOwnProperty]] defineProperty
[[HasProperty]] has
[[Get]] get
[[Set]] set
[[Delete]] deleteProperty
[[OwnPropertyKeys]] ownKeys
[[Call]] apply
[[Construct]] construct

ハンドラーメソッドが Proxy オブジェクト内部メソッドの実装として呼び出されるとき、そのハンドラーメソッドにはプロキシのターゲットオブジェクトがパラメータとして渡される。プロキシのハンドラーオブジェクトは必ずしもすべての本質的な内部メソッドに対応するメソッドを持つ必要はない。プロキシ上で内部メソッドが呼ばれた際に、ハンドラーオブジェクトが該当するトラップメソッドを持たない場合は、プロキシのターゲットオブジェクト上の対応する内部メソッドが呼び出される。

Proxy オブジェクトの [[ProxyHandler]] および [[ProxyTarget]] 内部スロットは、オブジェクト生成時に常に初期化され、通常は変更されない。一部の Proxy オブジェクトは、生成後にrevoke(無効化)できるような方法で作成される。プロキシが無効化されると、その [[ProxyHandler]] および [[ProxyTarget]] 内部スロットは null に設定され、その後その Proxy オブジェクト上の内部メソッドを呼び出すと TypeError 例外がスローされる。

Proxy オブジェクトは本質的な内部メソッドの実装を任意の ECMAScript コードで提供可能であるため、ハンドラーメソッドが 6.1.7.3 で定義される不変条件(invariant)を破る Proxy オブジェクトを定義することも可能である。6.1.7.3 で定義される内部メソッドの不変条件のうち、いくつかは本質的な完全性不変条件である。これらの不変条件は本節で規定される Proxy オブジェクト内部メソッドによって明示的に強制される。ECMAScript 実装は、あらゆる不変条件違反が発生し得る状況でも堅牢でなければならない。

以下のアルゴリズム記述では、O は ECMAScript Proxy オブジェクト、Pプロパティキー の値、V は任意の ECMAScript 言語値Descプロパティディスクリプタ レコードであると仮定する。

10.5.1 [[GetPrototypeOf]] ( )

Proxy エキゾチックオブジェクト O[[GetPrototypeOf]] 内部メソッドは引数を取らず、Object または null を含む normal completion または throw completion を返す。呼び出されたとき、次の手順を実行する:

  1. ValidateNonRevokedProxy(O) を実行する。
  2. targetO.[[ProxyTarget]] とする。
  3. handlerO.[[ProxyHandler]] とする。
  4. アサートhandlerObject である
  5. trap を ? GetMethod(handler, "getPrototypeOf") とする。
  6. もし trapundefined なら、
    1. target.[[GetPrototypeOf]]() を返す。
  7. handlerProto を ? Call(trap, handler, « target » ) とする。
  8. もし handlerProtoObject でない かつ handlerProtonull でない場合、TypeError 例外をスローする。
  9. extensibleTarget を ? IsExtensible(target) とする。
  10. もし extensibleTargettrue なら、handlerProto を返す。
  11. targetProto を ? target.[[GetPrototypeOf]]() とする。
  12. もし SameValue(handlerProto, targetProto) が false なら、TypeError 例外をスローする。
  13. handlerProto を返す。

Proxy オブジェクトの [[GetPrototypeOf]] は以下の不変条件を強制する:

  • [[GetPrototypeOf]] の結果は Object または null でなければならない。
  • ターゲットオブジェクトが拡張不可能な場合、Proxy オブジェクトに対する [[GetPrototypeOf]] は、ターゲットオブジェクトに対する [[GetPrototypeOf]] と同じ値を返さなければならない。

10.5.2 [[SetPrototypeOf]] ( V )

Proxy エキゾチックオブジェクト O[[SetPrototypeOf]] 内部メソッドは引数 V(Object または null)を取り、Boolean を含む normal completion または throw completion を返す。呼び出されたとき、次の手順を実行する:

  1. ValidateNonRevokedProxy(O) を実行する。
  2. targetO.[[ProxyTarget]] とする。
  3. handlerO.[[ProxyHandler]] とする。
  4. アサートhandlerObject である
  5. trap を ? GetMethod(handler, "setPrototypeOf") とする。
  6. もし trapundefined なら、
    1. target.[[SetPrototypeOf]](V) を返す。
  7. booleanTrapResultToBoolean(? Call(trap, handler, « target, V »)) とする。
  8. もし booleanTrapResultfalse なら、false を返す。
  9. extensibleTarget を ? IsExtensible(target) とする。
  10. もし extensibleTargettrue なら、true を返す。
  11. targetProto を ? target.[[GetPrototypeOf]]() とする。
  12. もし SameValue(V, targetProto) が false なら、TypeError 例外をスローする。
  13. true を返す。

Proxy オブジェクトの [[SetPrototypeOf]] は以下の不変条件を強制する:

  • [[SetPrototypeOf]] の結果は Boolean 値である。
  • ターゲットオブジェクトが拡張不可能な場合、引数の値はターゲットオブジェクトに対する [[GetPrototypeOf]] の結果と同じでなければならない。

10.5.3 [[IsExtensible]] ( )

Proxy エキゾチックオブジェクト O[[IsExtensible]] 内部メソッドは引数を取らず、Boolean を含む normal completion または throw completion を返す。呼び出されたとき、次の手順を実行する:

  1. ValidateNonRevokedProxy(O) を実行する。
  2. targetO.[[ProxyTarget]] とする。
  3. handlerO.[[ProxyHandler]] とする。
  4. アサートhandlerObject である
  5. trap を ? GetMethod(handler, "isExtensible") とする。
  6. もし trapundefined なら、
    1. IsExtensible(target) を返す。
  7. booleanTrapResultToBoolean(? Call(trap, handler, « target » )) とする。
  8. targetResult を ? IsExtensible(target) とする。
  9. もし booleanTrapResulttargetResult と異なる場合、TypeError 例外をスローする。
  10. booleanTrapResult を返す。

Proxy オブジェクトの [[IsExtensible]] は以下の不変条件を強制する:

  • [[IsExtensible]] の結果は Boolean 値である。
  • Proxy オブジェクトに対して [[IsExtensible]] を適用した結果は、同じ引数でターゲットオブジェクトに [[IsExtensible]] を適用した結果と同じでなければならない。

10.5.4 [[PreventExtensions]] ( )

Proxy エキゾチックオブジェクト O[[PreventExtensions]] 内部メソッドは引数を取らず、Boolean を含む normal completion または throw completion を返す。呼び出されたとき、次の手順を実行する:

  1. ValidateNonRevokedProxy(O) を実行する。
  2. targetO.[[ProxyTarget]] とする。
  3. handlerO.[[ProxyHandler]] とする。
  4. アサートhandlerObject である
  5. trap を ? GetMethod(handler, "preventExtensions") とする。
  6. もし trapundefined なら、
    1. target.[[PreventExtensions]]() を返す。
  7. booleanTrapResultToBoolean(? Call(trap, handler, « target » )) とする。
  8. もし booleanTrapResulttrue なら、
    1. extensibleTarget を ? IsExtensible(target) とする。
    2. もし extensibleTargettrue なら、TypeError 例外をスローする。
  9. booleanTrapResult を返す。

Proxy オブジェクトの [[PreventExtensions]] は以下の不変条件を強制する:

  • [[PreventExtensions]] の結果は Boolean 値である。
  • Proxy オブジェクトに対して [[PreventExtensions]] を適用した結果が true となるのは、ターゲットオブジェクトに対する [[IsExtensible]] の結果が false の場合のみである。

10.5.5 [[GetOwnProperty]] ( P )

Proxy エキゾチックオブジェクト O[[GetOwnProperty]] 内部メソッドは、引数 Pプロパティキー)を取り、normal completionProperty Descriptor または undefined を含む)、または throw completion を返す。呼び出されたとき、次の手順を実行する:

  1. ValidateNonRevokedProxy(O) を実行する。
  2. targetO.[[ProxyTarget]] とする。
  3. handlerO.[[ProxyHandler]] とする。
  4. アサート: handlerObject である
  5. trap を ? GetMethod(handler, "getOwnPropertyDescriptor") とする。
  6. もし trapundefined なら、
    1. target.[[GetOwnProperty]](P) を返す。
  7. trapResultObj を ? Call(trap, handler, « target, P » ) とする。
  8. もし trapResultObjObject でない かつ trapResultObjundefined でない場合、TypeError 例外をスローする。
  9. targetDesc を ? target.[[GetOwnProperty]](P) とする。
  10. もし trapResultObjundefined なら、
    1. もし targetDescundefined なら、undefined を返す。
    2. もし targetDesc.[[Configurable]]false なら、TypeError 例外をスローする。
    3. extensibleTarget を ? IsExtensible(target) とする。
    4. もし extensibleTargetfalse なら、TypeError 例外をスローする。
    5. undefined を返す。
  11. extensibleTarget を ? IsExtensible(target) とする。
  12. resultDesc を ? ToPropertyDescriptor(trapResultObj) とする。
  13. CompletePropertyDescriptor(resultDesc) を実行する。
  14. validIsCompatiblePropertyDescriptor(extensibleTarget, resultDesc, targetDesc) とする。
  15. もし validfalse なら、TypeError 例外をスローする。
  16. もし resultDesc.[[Configurable]]false なら、
    1. もし targetDescundefined または targetDesc.[[Configurable]]true なら、
      1. TypeError 例外をスローする。
    2. もし resultDesc[[Writable]] フィールドを持ち、かつ resultDesc.[[Writable]]false なら、
      1. アサート: targetDesc[[Writable]] フィールドを持つ。
      2. もし targetDesc.[[Writable]]true なら、TypeError 例外をスローする。
  17. resultDesc を返す。

Proxy オブジェクトの [[GetOwnProperty]] は以下の不変条件を強制する:

  • [[GetOwnProperty]] の結果は Object または undefined でなければならない。
  • ターゲットオブジェクトの non-configurable な own プロパティが存在する場合、そのプロパティは存在しないと報告できない。
  • ターゲットオブジェクトに own プロパティが存在し、かつターゲットオブジェクトが拡張不可能な場合、そのプロパティは存在しないと報告できない。
  • ターゲットオブジェクトに own プロパティが存在しない、かつターゲットオブジェクトが拡張不可能な場合、そのプロパティは存在すると報告できない。
  • non-configurable として報告できるのは、ターゲットオブジェクトの non-configurable な own プロパティが存在する場合のみである。
  • non-configurable かつ non-writable として報告できるのは、ターゲットオブジェクトに non-configurable かつ non-writable な own プロパティが存在する場合のみである。

10.5.6 [[DefineOwnProperty]] ( P, Desc )

Proxy エキゾチックオブジェクト O[[DefineOwnProperty]] 内部メソッドは、引数 Pプロパティキー)および DescProperty Descriptor)を取り、normal completion(Boolean を含む)、または throw completion を返す。呼び出されたとき、次の手順を実行する:

  1. ValidateNonRevokedProxy(O) を実行する。
  2. targetO.[[ProxyTarget]] とする。
  3. handlerO.[[ProxyHandler]] とする。
  4. アサート: handlerObject である
  5. trap を ? GetMethod(handler, "defineProperty") とする。
  6. もし trapundefined なら、
    1. target.[[DefineOwnProperty]](P, Desc) を返す。
  7. descObjFromPropertyDescriptor(Desc) とする。
  8. booleanTrapResultToBoolean(? Call(trap, handler, « target, P, descObj »)) とする。
  9. もし booleanTrapResultfalse なら、false を返す。
  10. targetDesc を ? target.[[GetOwnProperty]](P) とする。
  11. extensibleTarget を ? IsExtensible(target) とする。
  12. もし Desc[[Configurable]] フィールドを持ち、かつ Desc.[[Configurable]]false なら、
    1. settingConfigFalsetrue とする。
  13. それ以外の場合、
    1. settingConfigFalsefalse とする。
  14. もし targetDescundefined なら、
    1. もし extensibleTargetfalse なら、TypeError 例外をスローする。
    2. もし settingConfigFalsetrue なら、TypeError 例外をスローする。
  15. それ以外の場合、
    1. もし IsCompatiblePropertyDescriptor(extensibleTarget, Desc, targetDesc) が false なら、TypeError 例外をスローする。
    2. もし settingConfigFalsetrue かつ targetDesc.[[Configurable]]true なら、TypeError 例外をスローする。
    3. もし IsDataDescriptor(targetDesc) が true かつ targetDesc.[[Configurable]]false かつ targetDesc.[[Writable]]true なら、
      1. もし Desc[[Writable]] フィールドを持ち、かつ Desc.[[Writable]]false なら、TypeError 例外をスローする。
  16. true を返す。

Proxy オブジェクトの [[DefineOwnProperty]] は以下の不変条件を強制する:

  • [[DefineOwnProperty]] の結果は Boolean 値である。
  • ターゲットオブジェクトが拡張不可能な場合、プロパティを追加できない。
  • non-configurable にできるのは、対応する non-configurable なターゲットオブジェクトの own プロパティが存在する場合のみ。
  • non-configurable かつ non-writable にできるのは、対応する non-configurable かつ non-writable なターゲットオブジェクトの own プロパティが存在する場合のみ。
  • プロパティに対応するターゲットオブジェクトのプロパティが存在する場合、そのプロパティディスクリプタをターゲットオブジェクトに [[DefineOwnProperty]] で適用しても例外は発生しない。

10.5.7 [[HasProperty]] ( P )

Proxy エキゾチックオブジェクト O[[HasProperty]] 内部メソッドは、引数 Pプロパティキー)を取り、normal completion(Boolean を含む)、または throw completion を返す。呼び出されたとき、次の手順を実行する:

  1. ValidateNonRevokedProxy(O) を実行する。
  2. targetO.[[ProxyTarget]] とする。
  3. handlerO.[[ProxyHandler]] とする。
  4. アサート: handlerObject である
  5. trap を ? GetMethod(handler, "has") とする。
  6. もし trapundefined なら、
    1. target.[[HasProperty]](P) を返す。
  7. booleanTrapResultToBoolean(? Call(trap, handler, « target, P » )) とする。
  8. もし booleanTrapResultfalse なら、
    1. targetDesc を ? target.[[GetOwnProperty]](P) とする。
    2. もし targetDescundefined でなければ、
      1. もし targetDesc.[[Configurable]]false なら、TypeError 例外をスローする。
      2. extensibleTarget を ? IsExtensible(target) とする。
      3. もし extensibleTargetfalse なら、TypeError 例外をスローする。
  9. booleanTrapResult を返す。

Proxy オブジェクトの [[HasProperty]] は以下の不変条件を強制する:

  • [[HasProperty]] の結果は Boolean 値である。
  • ターゲットオブジェクトの non-configurable な own プロパティが存在する場合、そのプロパティは存在しないと報告できない。
  • ターゲットオブジェクトに own プロパティが存在し、かつターゲットオブジェクトが拡張不可能な場合、そのプロパティは存在しないと報告できない。

10.5.8 [[Get]] ( P, Receiver )

Proxy エキゾチックオブジェクト O[[Get]] 内部メソッドは、引数 Pプロパティキー)および ReceiverECMAScript 言語値)を取り、 normal completionECMAScript 言語値を含む)、または throw completion を返す。呼び出されたとき、次の手順を実行する:

  1. ValidateNonRevokedProxy(O) を実行する。
  2. targetO.[[ProxyTarget]] とする。
  3. handlerO.[[ProxyHandler]] とする。
  4. アサート: handlerObject である
  5. trap を ? GetMethod(handler, "get") とする。
  6. もし trapundefined なら、
    1. target.[[Get]](P, Receiver) を返す。
  7. trapResult を ? Call(trap, handler, « target, P, Receiver » ) とする。
  8. targetDesc を ? target.[[GetOwnProperty]](P) とする。
  9. もし targetDescundefined でなく、かつ targetDesc.[[Configurable]]false なら、
    1. もし IsDataDescriptor(targetDesc) が true かつ targetDesc.[[Writable]]false なら、
      1. もし SameValue(trapResult, targetDesc.[[Value]]) が false なら、TypeError 例外をスローする。
    2. もし IsAccessorDescriptor(targetDesc) が true かつ targetDesc.[[Get]]undefined なら、
      1. もし trapResultundefined でない場合、TypeError 例外をスローする。
  10. trapResult を返す。

Proxy オブジェクトの [[Get]] は以下の不変条件を強制する:

  • 対応するターゲットオブジェクトのプロパティが non-writable, non-configurable な own データプロパティ の場合、プロパティの値はターゲットオブジェクトのプロパティの値と同じでなければならない。
  • 対応するターゲットオブジェクトのプロパティが [[Get]] 属性が undefined である non-configurable な own アクセサプロパティ の場合、プロパティの値は undefined でなければならない。

10.5.9 [[Set]] ( P, V, Receiver )

Proxy エキゾチックオブジェクト O[[Set]] 内部メソッドは、引数 Pプロパティキー)、VECMAScript 言語値)、ReceiverECMAScript 言語値)を取り、normal completion(Boolean を含む)、または throw completion を返す。呼び出されたとき、次の手順を実行する:

  1. ValidateNonRevokedProxy(O) を実行する。
  2. targetO.[[ProxyTarget]] とする。
  3. handlerO.[[ProxyHandler]] とする。
  4. アサート: handlerObject である
  5. trap を ? GetMethod(handler, "set") とする。
  6. もし trapundefined なら、
    1. target.[[Set]](P, V, Receiver) を返す。
  7. booleanTrapResultToBoolean(? Call(trap, handler, « target, P, V, Receiver »)) とする。
  8. もし booleanTrapResultfalse なら、false を返す。
  9. targetDesc を ? target.[[GetOwnProperty]](P) とする。
  10. もし targetDescundefined でなく、 targetDesc.[[Configurable]]false なら、
    1. もし IsDataDescriptor(targetDesc) が true かつ targetDesc.[[Writable]]false なら、
      1. SameValue(V, targetDesc.[[Value]]) が false なら、TypeError 例外をスローする。
    2. もし IsAccessorDescriptor(targetDesc) が true なら、
      1. もし targetDesc.[[Set]]undefined なら、TypeError 例外をスローする。
  11. true を返す。

Proxy オブジェクトの [[Set]] は次の不変条件を強制する:

  • [[Set]] の結果は Boolean 値である。
  • 対応するターゲットオブジェクトのプロパティが非書き込み・非設定可能な own データプロパティ の場合、その値をターゲットオブジェクトの値と異なる値に変更することはできない。
  • 対応するターゲットオブジェクトのプロパティが アクセサプロパティ かつ [[Set]] 属性が undefined の場合、その値を設定することはできない。

10.5.10 [[Delete]] ( P )

Proxy エキゾチックオブジェクト O[[Delete]] 内部メソッドは、引数 Pプロパティキー)を取り、 normal completion(Boolean を含む)、または throw completion を返す。呼び出されたとき、次の手順を実行する:

  1. ValidateNonRevokedProxy(O) を実行する。
  2. targetO.[[ProxyTarget]] とする。
  3. handlerO.[[ProxyHandler]] とする。
  4. アサート: handlerObject である
  5. trap を ? GetMethod(handler, "deleteProperty") とする。
  6. もし trapundefined なら、
    1. target.[[Delete]](P) を返す。
  7. booleanTrapResultToBoolean(? Call(trap, handler, « target, P »)) とする。
  8. もし booleanTrapResultfalse なら、false を返す。
  9. targetDesc を ? target.[[GetOwnProperty]](P) とする。
  10. もし targetDescundefined なら、true を返す。
  11. もし targetDesc.[[Configurable]]false なら、TypeError 例外をスローする。
  12. extensibleTarget を ? IsExtensible(target) とする。
  13. もし extensibleTargetfalse なら、TypeError 例外をスローする。
  14. true を返す。

Proxy オブジェクトの [[Delete]] は次の不変条件を強制する:

  • [[Delete]] の結果は Boolean 値である。
  • 対象プロパティがターゲットオブジェクトの非設定可能 own プロパティである場合、それを削除済みとして報告することはできない。
  • 対象プロパティがターゲットオブジェクトの own プロパティであり、ターゲットオブジェクトが拡張不可能な場合、それを削除済みとして報告することはできない。

10.5.11 [[OwnPropertyKeys]] ( )

Proxy エキゾチックオブジェクト O[[OwnPropertyKeys]] 内部メソッドは引数を取らず、normal completionリストプロパティキー)を含む)、または throw completion を返す。呼び出されたとき、次の手順を実行する:

  1. ValidateNonRevokedProxy(O) を実行する。
  2. targetO.[[ProxyTarget]] とする。
  3. handlerO.[[ProxyHandler]] とする。
  4. アサート: handlerObject である
  5. trap を ? GetMethod(handler, "ownKeys") とする。
  6. もし trapundefined なら、
    1. target.[[OwnPropertyKeys]]() を返す。
  7. trapResultArray を ? Call(trap, handler, « target » ) とする。
  8. trapResult を ? CreateListFromArrayLike(trapResultArray, property-key) とする。
  9. もし trapResult に重複する要素が含まれていた場合、TypeError 例外をスローする。
  10. extensibleTarget を ? IsExtensible(target) とする。
  11. targetKeys を ? target.[[OwnPropertyKeys]]() とする。
  12. アサート: targetKeysリストプロパティキー)である。
  13. アサート: targetKeys には重複する要素は含まれていない。
  14. targetConfigurableKeys を新しい空の リスト とする。
  15. targetNonconfigurableKeys を新しい空の リスト とする。
  16. targetKeys の各要素 key について、
    1. desc を ? target.[[GetOwnProperty]](key) とする。
    2. もし descundefined でなく、desc.[[Configurable]]false なら、
      1. keytargetNonconfigurableKeys に追加する。
    3. それ以外の場合、
      1. keytargetConfigurableKeys に追加する。
  17. もし extensibleTargettrue かつ targetNonconfigurableKeys が空であるなら、
    1. trapResult を返す。
  18. uncheckedResultKeysリスト(要素は trapResult の要素)とする。
  19. targetNonconfigurableKeys の各要素 key について、
    1. もし uncheckedResultKeyskey が含まれなければ、TypeError 例外をスローする。
    2. keyuncheckedResultKeys から削除する。
  20. もし extensibleTargettrue なら、trapResult を返す。
  21. targetConfigurableKeys の各要素 key について、
    1. もし uncheckedResultKeyskey が含まれなければ、TypeError 例外をスローする。
    2. keyuncheckedResultKeys から削除する。
  22. もし uncheckedResultKeys が空でない場合、TypeError 例外をスローする。
  23. trapResult を返す。

Proxy オブジェクトの [[OwnPropertyKeys]] は次の不変条件を強制する:

  • [[OwnPropertyKeys]] の結果は リスト である。
  • 返される リスト には重複する要素が含まれていない。
  • 返される リスト の各要素は プロパティキー である。
  • 結果の リスト にはターゲットオブジェクトのすべての非設定可能な own プロパティのキーが含まれていなければならない。
  • ターゲットオブジェクトが拡張不可能な場合、結果の リスト にはターゲットオブジェクトのすべての own プロパティのキーが含まれ、それ以外の値を含んではならない。

10.5.12 [[Call]] ( thisArgument, argumentsList )

Proxy エキゾチックオブジェクト O[[Call]] 内部メソッドは、引数 thisArgumentECMAScript 言語値)および argumentsListリストECMAScript 言語値))を取り、 normal completionECMAScript 言語値を含む)、または throw completion を返す。呼び出されたとき、次の手順を実行する:

  1. ValidateNonRevokedProxy(O) を実行する。
  2. targetO.[[ProxyTarget]] とする。
  3. handlerO.[[ProxyHandler]] とする。
  4. アサート: handlerObject である
  5. trap を ? GetMethod(handler, "apply") とする。
  6. もし trapundefined なら、
    1. Call(target, thisArgument, argumentsList) を返す。
  7. argArrayCreateArrayFromList(argumentsList) とする。
  8. Call(trap, handler, « target, thisArgument, argArray » ) を返す。

Proxy エキゾチックオブジェクト は、その [[ProxyTarget]] 内部スロットの初期値が [[Call]] 内部メソッドを持つオブジェクトである場合のみ [[Call]] 内部メソッドを持つ。

10.5.13 [[Construct]] ( argumentsList, newTarget )

Proxy エキゾチックオブジェクト O[[Construct]] 内部メソッドは、引数 argumentsListリストECMAScript 言語値))、newTargetコンストラクタ)を取り、normal completion(Object を含む)、または throw completion を返す。呼び出されたとき、次の手順を実行する:

  1. ValidateNonRevokedProxy(O) を実行する。
  2. targetO.[[ProxyTarget]] とする。
  3. アサート: IsConstructor(target) は true である。
  4. handlerO.[[ProxyHandler]] とする。
  5. アサート: handlerObject である
  6. trap を ? GetMethod(handler, "construct") とする。
  7. もし trapundefined なら、
    1. Construct(target, argumentsList, newTarget) を返す。
  8. argArrayCreateArrayFromList(argumentsList) とする。
  9. newObj を ? Call(trap, handler, « target, argArray, newTarget » ) とする。
  10. もし newObjObject でない場合、TypeError 例外をスローする。
  11. newObj を返す。
注 1

Proxy エキゾチックオブジェクト は、その [[ProxyTarget]] 内部スロットの初期値が [[Construct]] 内部メソッドを持つオブジェクトである場合のみ [[Construct]] 内部メソッドを持つ。

注 2

Proxy オブジェクトの [[Construct]] は次の不変条件を強制する:

  • [[Construct]] の結果は Object でなければならない。

10.5.14 ValidateNonRevokedProxy ( proxy )

抽象操作 ValidateNonRevokedProxy は、引数 proxyProxy エキゾチックオブジェクト)を取り、unused を含む normal completion または throw completion を返す。proxy が revoke されている場合は TypeError 例外をスローする。呼び出されたとき、次の手順を実行する:

  1. もし proxy.[[ProxyTarget]]null なら、TypeError 例外をスローする。
  2. アサートproxy.[[ProxyHandler]]null ではない。
  3. unused を返す。

10.5.15 ProxyCreate ( target, handler )

抽象操作 ProxyCreate は、引数 targetECMAScript 言語値)、handlerECMAScript 言語値)を取り、Proxy エキゾチックオブジェクトを含む normal completion または throw completion を返す。新しい Proxy オブジェクトの生成を指定するために使われる。呼び出されたとき、次の手順を実行する:

  1. もし targetObject でない場合、TypeError 例外をスローする。
  2. もし handlerObject でない場合、TypeError 例外をスローする。
  3. PMakeBasicObject[[ProxyHandler]], [[ProxyTarget]] ») とする。
  4. P の本質的な内部メソッド([[Call]] および [[Construct]] を除く)を、10.5 で指定された定義に設定する。
  5. もし IsCallable(target) が true なら、
    1. P.[[Call]]10.5.12 で指定されたとおりに設定する。
    2. もし IsConstructor(target) が true なら、
      1. P.[[Construct]]10.5.13 で指定されたとおりに設定する。
  6. P.[[ProxyTarget]]target を設定する。
  7. P.[[ProxyHandler]]handler を設定する。
  8. P を返す。

11 ECMAScript 言語:ソーステキスト

11.1 ソーステキスト

構文

SourceCharacter :: 任意の Unicode コードポイント

ECMAScript ソーステキストは、Unicode コードポイントの列である。U+0000 から U+10FFFF までのすべての Unicode コードポイント値(サロゲートコードポイントを含む)は、ECMAScript 文法で許可される場所で ECMAScript ソーステキスト内に出現できる。ECMAScript ソーステキストを保存・交換する際に用いられる実際のエンコーディングは本仕様に関係しない。外部ソーステキストのエンコーディングに関わらず、適合 ECMAScript 実装は、ソーステキストを等価な SourceCharacter 値の列として処理し、それぞれの SourceCharacter は Unicode コードポイントである。適合 ECMAScript 実装はソーステキストの正規化を行う必要はなく、正規化を行っているかのように振る舞う必要もない。

結合文字列の構成要素は、ユーザーが全体を 1 文字と考える場合でも、個々の Unicode コードポイントとして扱われる。

文字列リテラル、正規表現リテラル、テンプレートリテラル、識別子では、任意の Unicode コードポイントも、その数値値を明示的に表す Unicode エスケープシーケンスで表すことができる。コメント内では、このようなエスケープシーケンスはコメントの一部として事実上無視される。

ECMAScript は、Unicode エスケープシーケンスの振る舞いが Java プログラミング言語と異なる。たとえば Java プログラム内で \u000A のようなエスケープシーケンスが単一行コメント内に現れると、それは行終端子(Unicode コードポイント U+000A:LINE FEED (LF))として解釈され、次のコードポイントはコメントの一部とならない。同様に、Java プログラムの文字列リテラル内で \u000A が現れると、それも行終端子と解釈され、文字列リテラル内に行終端子を含めることはできない。LINE FEED (LF) を文字列リテラルの値の一部にしたい場合は \n を使う必要がある。ECMAScript プログラムでは、コメント内の Unicode エスケープシーケンスは決して解釈されず、コメントの終了に寄与することはない。同様に、ECMAScript プログラム内の文字列リテラル内で発生する Unicode エスケープシーケンスは常にリテラルの一部となり、行終端子や文字列リテラルの終了となるコードポイントとして解釈されることはない。

11.1.1 静的セマンティクス: UTF16EncodeCodePoint ( cp )

抽象操作 UTF16EncodeCodePoint は、引数 cp(Unicode コードポイント)を取り、文字列を返す。呼び出されたとき、次の手順を実行する:

  1. アサート: 0 ≤ cp ≤ 0x10FFFF.
  2. もし cp ≤ 0xFFFF なら、数値値が cp であるコードユニットからなる文字列値を返す。
  3. cu1 を、数値値が floor((cp - 0x10000) / 0x400) + 0xD800 であるコードユニットとする。
  4. cu2 を、数値値が ((cp - 0x10000) modulo 0x400) + 0xDC00 であるコードユニットとする。
  5. cu1cu2文字列連結を返す。

11.1.2 静的セマンティクス: CodePointsToString ( text )

抽象操作 CodePointsToString は、引数 text(Unicode コードポイント列)を取り、文字列を返す。text6.1.4 で記述されるように、文字列値に変換する。呼び出されたとき、次の手順を実行する:

  1. result を空文字列とする。
  2. text の各コードポイント cp について、
    1. resultresultUTF16EncodeCodePoint(cp) の 文字列連結 に設定する。
  3. result を返す。

11.1.3 静的セマンティクス: UTF16SurrogatePairToCodePoint ( lead, trail )

抽象操作 UTF16SurrogatePairToCodePoint は、引数 lead(コードユニット)、trail(コードユニット)を取り、コードポイントを返す。UTF-16 サロゲートペア を成す 2 つのコードユニットをコードポイントに変換する。呼び出されたとき、次の手順を実行する:

  1. アサート: leadリーディングサロゲートであり、trailトレーリングサロゲートである。
  2. cp を (lead - 0xD800) × 0x400 + (trail - 0xDC00) + 0x10000 とする。
  3. コードポイント cp を返す。

11.1.4 静的セマンティクス: CodePointAt ( string, position )

抽象操作 CodePointAt は、引数 string(文字列)、position(非負の 整数)を取り、Record[[CodePoint]](コードポイント)、[[CodeUnitCount]](正の 整数)、[[IsUnpairedSurrogate]](Boolean)フィールドを持つ)を返す。string6.1.4 で記述されるように UTF-16 エンコードされたコードポイント列として解釈し、position 番目のコードユニットから始まる 1 つのコードポイントを読み取る。呼び出されたとき、次の手順を実行する:

  1. sizestring の長さとする。
  2. アサート: position ≥ 0 かつ position < size
  3. firststringposition 番目のコードユニットとする。
  4. cpfirst の数値値を持つコードポイントとする。
  5. もし firstリーディングサロゲートでもトレーリングサロゲートでもない場合、
    1. Record { [[CodePoint]]: cp, [[CodeUnitCount]]: 1, [[IsUnpairedSurrogate]]: false } を返す。
  6. もし firstトレーリングサロゲートであるか、position + 1 = size なら、
    1. Record { [[CodePoint]]: cp, [[CodeUnitCount]]: 1, [[IsUnpairedSurrogate]]: true } を返す。
  7. secondstringposition + 1 番目のコードユニットとする。
  8. もし secondトレーリングサロゲートでない場合、
    1. Record { [[CodePoint]]: cp, [[CodeUnitCount]]: 1, [[IsUnpairedSurrogate]]: true } を返す。
  9. cpUTF16SurrogatePairToCodePoint(first, second) に設定する。
  10. Record { [[CodePoint]]: cp, [[CodeUnitCount]]: 2, [[IsUnpairedSurrogate]]: false } を返す。

11.1.5 静的セマンティクス: StringToCodePoints ( string )

抽象操作 StringToCodePoints は、引数 string(文字列)を取り、コードポイントのリストを返す。string6.1.4 で記述されるように UTF-16 エンコードされた Unicode テキストとして解釈し、そこから得られる Unicode コードポイント列を返す。呼び出されたとき、次の手順を実行する:

  1. codePoints を新しい空の リストとする。
  2. sizestring の長さとする。
  3. position を 0 とする。
  4. position < size の間、繰り返す:
    1. cpCodePointAt(string, position) に設定する。
    2. cp.[[CodePoint]]codePoints に追加する。
    3. positionposition + cp.[[CodeUnitCount]] に設定する。
  5. codePoints を返す。

11.1.6 静的セマンティクス: ParseText ( sourceText, goalSymbol )

抽象操作 ParseText は、引数 sourceText(文字列または Unicode コードポイント列)、goalSymbol(ECMAScript 文法の非終端記号)を取り、Parse Node または非空の SyntaxError オブジェクトのリスト を返す。呼び出されたとき、次の手順を実行する:

  1. もし sourceText文字列 なら、sourceTextStringToCodePoints(sourceText) に設定する。
  2. sourceTextgoalSymbolゴール記号として用いて構文解析し、パース結果について early error 条件を解析する。構文解析および early error 検出は、実装定義の方法でインタリーブされてもよい。
  3. 構文解析が成功し、early errors が見つからなかった場合、パースツリーのルートである Parse NodegoalSymbol のインスタンス)を返す。
  4. それ以外の場合、解析エラーおよび/または early errors を表す 1 つ以上の SyntaxError オブジェクトのリスト を返す。複数の解析エラーまたは early error がある場合、そのリスト内のエラーオブジェクトの数や順序は 実装定義 だが、少なくとも 1 つは存在しなければならない。
注 1

あるテキストに特定の場所で early error があり、その後に構文エラーがある場合を考える。構文解析の後に early errors のパスを行う実装は構文エラーのみを報告し、その後 early errors のパスには進まないかもしれない。2 つの処理をインタリーブする実装は early error のみを報告し、構文エラーには進まないかもしれない。3 つ目の実装は両方を報告するかもしれない。いずれも適合している。

注 2

詳細は 17 節も参照。

11.2 ソースコードの種類

ECMAScript コードには4つの種類がある:

注 1

関数コードは通常、関数定義(15.2)、アロー関数定義(15.3)、メソッド定義(15.4)、ジェネレーター関数定義(15.5)、非同期関数定義(15.8)、非同期ジェネレーター関数定義(15.6)、および非同期アロー関数(15.9)の本体として提供される。また、関数 constructor20.2.1.1)、GeneratorFunction constructor27.3.1.1)、AsyncFunction constructor27.7.1.1)、および AsyncGeneratorFunction constructor27.4.1.1)の引数からも関数コードが生成される。

注 2

関数コードに BindingIdentifier を含める実際的な効果は、strict mode code の Early Errors が、「use strict」ディレクティブを本体に含む関数の名前となっている BindingIdentifier にも適用されることである。これは、周囲のコードが strict mode code でなくても同様である。

11.2.1 ディレクティブプロローグと use strict ディレクティブ

ディレクティブプロローグとは、ExpressionStatementStatementListItem または ModuleItem の先頭部分として出現し、かつそのシーケンス内の各 ExpressionStatementStringLiteral トークンのみとセミコロンからなる最長の列である。セミコロンは明示的でもよいし、自動セミコロン挿入(12.10)によって挿入されてもよい。ディレクティブプロローグ は空列でもよい。

use strict ディレクティブとは、ディレクティブプロローグ 中の ExpressionStatement であって、その StringLiteral が正確に "use strict" または 'use strict' というコードポイント列であるものである。use strict ディレクティブ には EscapeSequenceLineContinuation を含めてはならない。

ディレクティブプロローグ には複数の use strict ディレクティブ を含めてもよい。ただし、これが発生した場合、実装が警告を出すことがある。

ディレクティブプロローグExpressionStatement は、包含している生成規則の評価時に通常通り評価される。ディレクティブプロローグ 内にあり、かつ use strict ディレクティブ でなく、実装によって意味が定義されていない ExpressionStatement に遭遇した場合、通知メカニズムがあれば実装は警告を出すべきである。

11.2.2 厳格モードコード

ECMAScript の構文単位は、無制限モードまたは厳格モードの構文と意味(4.3.2)で処理されることがある。次の場合、そのコードは 厳格モードコード として解釈される:

厳格モードコードでない ECMAScript コードは、非厳格コード と呼ばれる。

11.2.2.1 静的セマンティクス: IsStrict ( node )

抽象操作 IsStrict は、引数 node構文ノード)を取り、Boolean を返す。呼び出されたとき、次の手順を実行する:

  1. もし node にマッチしたソーステキスト厳格モードコード であれば true を返し、そうでなければ false を返す。

11.2.3 非ECMAScript関数

ECMAScript の実装は、評価動作が ECMAScript ソーステキスト 以外の ホスト定義 の実行可能コードで表現される エキゾチックオブジェクト の関数を評価することをサポートしてもよい。関数オブジェクト が ECMAScript コード内で定義されたか、組み込み関数であるかは、そのような 関数オブジェクト を呼び出したり呼び出されたりする ECMAScript コードの視点からは観測できない。

12 ECMAScript Language: Lexical Grammar

The source text of an ECMAScript Script or Module is first converted into a sequence of input elements, which are tokens, line terminators, comments, or white space. The source text is scanned from left to right, repeatedly taking the longest possible sequence of code points as the next input element.

There are several situations where the identification of lexical input elements is sensitive to the syntactic grammar context that is consuming the input elements. This requires multiple goal symbols for the lexical grammar. The InputElementHashbangOrRegExp goal is used at the start of a Script or Module. The InputElementRegExpOrTemplateTail goal is used in syntactic grammar contexts where a RegularExpressionLiteral, a TemplateMiddle, or a TemplateTail is permitted. The InputElementRegExp goal symbol is used in all syntactic grammar contexts where a RegularExpressionLiteral is permitted but neither a TemplateMiddle, nor a TemplateTail is permitted. The InputElementTemplateTail goal is used in all syntactic grammar contexts where a TemplateMiddle or a TemplateTail is permitted but a RegularExpressionLiteral is not permitted. In all other contexts, InputElementDiv is used as the lexical goal symbol.

Note

The use of multiple lexical goals ensures that there are no lexical ambiguities that would affect automatic semicolon insertion. For example, there are no syntactic grammar contexts where both a leading division or division-assignment, and a leading RegularExpressionLiteral are permitted. This is not affected by semicolon insertion (see 12.10); in examples such as the following:

a = b
/hi/g.exec(c).map(d);

where the first non-whitespace, non-comment code point after a LineTerminator is U+002F (SOLIDUS) and the syntactic context allows division or division-assignment, no semicolon is inserted at the LineTerminator. That is, the above example is interpreted in the same way as:

a = b / hi / g.exec(c).map(d);

Syntax

InputElementDiv :: WhiteSpace LineTerminator Comment CommonToken DivPunctuator RightBracePunctuator InputElementRegExp :: WhiteSpace LineTerminator Comment CommonToken RightBracePunctuator RegularExpressionLiteral InputElementRegExpOrTemplateTail :: WhiteSpace LineTerminator Comment CommonToken RegularExpressionLiteral TemplateSubstitutionTail InputElementTemplateTail :: WhiteSpace LineTerminator Comment CommonToken DivPunctuator TemplateSubstitutionTail InputElementHashbangOrRegExp :: WhiteSpace LineTerminator Comment CommonToken HashbangComment RegularExpressionLiteral

12.1 Unicode Format-Control Characters

The Unicode format-control characters (i.e., the characters in category “Cf” in the Unicode Character Database such as LEFT-TO-RIGHT MARK or RIGHT-TO-LEFT MARK) are control codes used to control the formatting of a range of text in the absence of higher-level protocols for this (such as mark-up languages).

It is useful to allow format-control characters in source text to facilitate editing and display. All format control characters may be used within comments, and within string literals, template literals, and regular expression literals.

U+FEFF (ZERO WIDTH NO-BREAK SPACE) is a format-control character used primarily at the start of a text to mark it as Unicode and to allow detection of the text's encoding and byte order. <ZWNBSP> characters intended for this purpose can sometimes also appear after the start of a text, for example as a result of concatenating files. In ECMAScript source text <ZWNBSP> code points are treated as white space characters (see 12.2) outside of comments, string literals, template literals, and regular expression literals.

12.2 White Space

White space code points are used to improve source text readability and to separate tokens (indivisible lexical units) from each other, but are otherwise insignificant. White space code points may occur between any two tokens and at the start or end of input. White space code points may occur within a StringLiteral, a RegularExpressionLiteral, a Template, or a TemplateSubstitutionTail where they are considered significant code points forming part of a literal value. They may also occur within a Comment, but cannot appear within any other kind of token.

The ECMAScript white space code points are listed in Table 35.

Table 35: White Space Code Points
Code Points Name Abbreviation
U+0009 CHARACTER TABULATION <TAB>
U+000B LINE TABULATION <VT>
U+000C FORM FEED (FF) <FF>
U+FEFF ZERO WIDTH NO-BREAK SPACE <ZWNBSP>
any code point in general category “Space_Separator” <USP>
Note 1

U+0020 (SPACE) and U+00A0 (NO-BREAK SPACE) code points are part of <USP>.

Note 2

Other than for the code points listed in Table 35, ECMAScript WhiteSpace intentionally excludes all code points that have the Unicode “White_Space” property but which are not classified in general category “Space_Separator” (“Zs”).

Syntax

WhiteSpace :: <TAB> <VT> <FF> <ZWNBSP> <USP>

12.3 Line Terminators

Like white space code points, line terminator code points are used to improve source text readability and to separate tokens (indivisible lexical units) from each other. However, unlike white space code points, line terminators have some influence over the behaviour of the syntactic grammar. In general, line terminators may occur between any two tokens, but there are a few places where they are forbidden by the syntactic grammar. Line terminators also affect the process of automatic semicolon insertion (12.10). A line terminator cannot occur within any token except a StringLiteral, Template, or TemplateSubstitutionTail. <LF> and <CR> line terminators cannot occur within a StringLiteral token except as part of a LineContinuation.

A line terminator can occur within a MultiLineComment but cannot occur within a SingleLineComment.

Line terminators are included in the set of white space code points that are matched by the \s class in regular expressions.

The ECMAScript line terminator code points are listed in Table 36.

Table 36: Line Terminator Code Points
Code Point Unicode Name Abbreviation
U+000A LINE FEED (LF) <LF>
U+000D CARRIAGE RETURN (CR) <CR>
U+2028 LINE SEPARATOR <LS>
U+2029 PARAGRAPH SEPARATOR <PS>

Only the Unicode code points in Table 36 are treated as line terminators. Other new line or line breaking Unicode code points are not treated as line terminators but are treated as white space if they meet the requirements listed in Table 35. The sequence <CR><LF> is commonly used as a line terminator. It should be considered a single SourceCharacter for the purpose of reporting line numbers.

Syntax

LineTerminator :: <LF> <CR> <LS> <PS> LineTerminatorSequence :: <LF> <CR> [lookahead ≠ <LF>] <LS> <PS> <CR> <LF>

12.4 Comments

Comments can be either single or multi-line. Multi-line comments cannot nest.

Because a single-line comment can contain any Unicode code point except a LineTerminator code point, and because of the general rule that a token is always as long as possible, a single-line comment always consists of all code points from the // marker to the end of the line. However, the LineTerminator at the end of the line is not considered to be part of the single-line comment; it is recognized separately by the lexical grammar and becomes part of the stream of input elements for the syntactic grammar. This point is very important, because it implies that the presence or absence of single-line comments does not affect the process of automatic semicolon insertion (see 12.10).

Comments behave like white space and are discarded except that, if a MultiLineComment contains a line terminator code point, then the entire comment is considered to be a LineTerminator for purposes of parsing by the syntactic grammar.

Syntax

Comment :: MultiLineComment SingleLineComment MultiLineComment :: /* MultiLineCommentCharsopt */ MultiLineCommentChars :: MultiLineNotAsteriskChar MultiLineCommentCharsopt * PostAsteriskCommentCharsopt PostAsteriskCommentChars :: MultiLineNotForwardSlashOrAsteriskChar MultiLineCommentCharsopt * PostAsteriskCommentCharsopt MultiLineNotAsteriskChar :: SourceCharacter but not * MultiLineNotForwardSlashOrAsteriskChar :: SourceCharacter but not one of / or * SingleLineComment :: // SingleLineCommentCharsopt SingleLineCommentChars :: SingleLineCommentChar SingleLineCommentCharsopt SingleLineCommentChar :: SourceCharacter but not LineTerminator

A number of productions in this section are given alternative definitions in section B.1.1

12.5 Hashbang Comments

Hashbang Comments are location-sensitive and like other types of comments are discarded from the stream of input elements for the syntactic grammar.

Syntax

HashbangComment :: #! SingleLineCommentCharsopt

12.6 Tokens

Syntax

CommonToken :: IdentifierName PrivateIdentifier Punctuator NumericLiteral StringLiteral Template Note

The DivPunctuator, RegularExpressionLiteral, RightBracePunctuator, and TemplateSubstitutionTail productions derive additional tokens that are not included in the CommonToken production.

12.7 Names and Keywords

IdentifierName and ReservedWord are tokens that are interpreted according to the Default Identifier Syntax given in Unicode Standard Annex #31, Identifier and Pattern Syntax, with some small modifications. ReservedWord is an enumerated subset of IdentifierName. The syntactic grammar defines Identifier as an IdentifierName that is not a ReservedWord. The Unicode identifier grammar is based on character properties specified by the Unicode Standard. The Unicode code points in the specified categories in the latest version of the Unicode Standard must be treated as in those categories by all conforming ECMAScript implementations. ECMAScript implementations may recognize identifier code points defined in later editions of the Unicode Standard.

Note 1

This standard specifies specific code point additions: U+0024 (DOLLAR SIGN) and U+005F (LOW LINE) are permitted anywhere in an IdentifierName.

Syntax

PrivateIdentifier :: # IdentifierName IdentifierName :: IdentifierStart IdentifierName IdentifierPart IdentifierStart :: IdentifierStartChar \ UnicodeEscapeSequence IdentifierPart :: IdentifierPartChar \ UnicodeEscapeSequence IdentifierStartChar :: UnicodeIDStart $ _ IdentifierPartChar :: UnicodeIDContinue $ AsciiLetter :: one of a b c d e f g h i j k l m n o p q r s t u v w x y z A B C D E F G H I J K L M N O P Q R S T U V W X Y Z UnicodeIDStart :: any Unicode code point with the Unicode property “ID_Start” UnicodeIDContinue :: any Unicode code point with the Unicode property “ID_Continue”

The definitions of the nonterminal UnicodeEscapeSequence is given in 12.9.4.

Note 2

The nonterminal IdentifierPart derives _ via UnicodeIDContinue.

Note 3

The sets of code points with Unicode properties “ID_Start” and “ID_Continue” include, respectively, the code points with Unicode properties “Other_ID_Start” and “Other_ID_Continue”.

12.7.1 Identifier Names

Unicode escape sequences are permitted in an IdentifierName, where they contribute a single Unicode code point equal to the IdentifierCodePoint of the UnicodeEscapeSequence. The \ preceding the UnicodeEscapeSequence does not contribute any code points. A UnicodeEscapeSequence cannot be used to contribute a code point to an IdentifierName that would otherwise be invalid. In other words, if a \ UnicodeEscapeSequence sequence were replaced by the SourceCharacter it contributes, the result must still be a valid IdentifierName that has the exact same sequence of SourceCharacter elements as the original IdentifierName. All interpretations of IdentifierName within this specification are based upon their actual code points regardless of whether or not an escape sequence was used to contribute any particular code point.

Two IdentifierNames that are canonically equivalent according to the Unicode Standard are not equal unless, after replacement of each UnicodeEscapeSequence, they are represented by the exact same sequence of code points.

12.7.1.1 Static Semantics: Early Errors

IdentifierStart :: \ UnicodeEscapeSequence IdentifierPart :: \ UnicodeEscapeSequence

12.7.1.2 Static Semantics: IdentifierCodePoints

The syntax-directed operation IdentifierCodePoints takes no arguments and returns a List of code points. It is defined piecewise over the following productions:

IdentifierName :: IdentifierStart
  1. Let cp be the IdentifierCodePoint of IdentifierStart.
  2. Return « cp ».
IdentifierName :: IdentifierName IdentifierPart
  1. Let cps be the IdentifierCodePoints of the derived IdentifierName.
  2. Let cp be the IdentifierCodePoint of IdentifierPart.
  3. Return the list-concatenation of cps and « cp ».

12.7.1.3 Static Semantics: IdentifierCodePoint

The syntax-directed operation IdentifierCodePoint takes no arguments and returns a code point. It is defined piecewise over the following productions:

IdentifierStart :: IdentifierStartChar
  1. Return the code point matched by IdentifierStartChar.
IdentifierPart :: IdentifierPartChar
  1. Return the code point matched by IdentifierPartChar.
UnicodeEscapeSequence :: u Hex4Digits
  1. Return the code point whose numeric value is the MV of Hex4Digits.
UnicodeEscapeSequence :: u{ CodePoint }
  1. Return the code point whose numeric value is the MV of CodePoint.

12.7.2 Keywords and Reserved Words

A keyword is a token that matches IdentifierName, but also has a syntactic use; that is, it appears literally, in a fixed width font, in some syntactic production. The keywords of ECMAScript include if, while, async, await, and many others.

A reserved word is an IdentifierName that cannot be used as an identifier. Many keywords are reserved words, but some are not, and some are reserved only in certain contexts. if and while are reserved words. await is reserved only inside async functions and modules. async is not reserved; it can be used as a variable name or statement label without restriction.

This specification uses a combination of grammatical productions and early error rules to specify which names are valid identifiers and which are reserved words. All tokens in the ReservedWord list below, except for await and yield, are unconditionally reserved. Exceptions for await and yield are specified in 13.1, using parameterized syntactic productions. Lastly, several early error rules restrict the set of valid identifiers. See 13.1.1, 14.3.1.1, 14.7.5.1, and 15.7.1. In summary, there are five categories of identifier names:

  • Those that are always allowed as identifiers, and are not keywords, such as Math, window, toString, and _;

  • Those that are never allowed as identifiers, namely the ReservedWords listed below except await and yield;

  • Those that are contextually allowed as identifiers, namely await and yield;

  • Those that are contextually disallowed as identifiers, in strict mode code: let, static, implements, interface, package, private, protected, and public;

  • Those that are always allowed as identifiers, but also appear as keywords within certain syntactic productions, at places where Identifier is not allowed: as, async, from, get, meta, of, set, and target.

The term conditional keyword, or contextual keyword, is sometimes used to refer to the keywords that fall in the last three categories, and thus can be used as identifiers in some contexts and as keywords in others.

Syntax

ReservedWord :: one of await break case catch class const continue debugger default delete do else enum export extends false finally for function if import in instanceof new null return super switch this throw true try typeof var void while with yield Note 1

Per 5.1.5, keywords in the grammar match literal sequences of specific SourceCharacter elements. A code point in a keyword cannot be expressed by a \ UnicodeEscapeSequence.

An IdentifierName can contain \ UnicodeEscapeSequences, but it is not possible to declare a variable named "else" by spelling it els\u{65}. The early error rules in 13.1.1 rule out identifiers with the same StringValue as a reserved word.

Note 2

enum is not currently used as a keyword in this specification. It is a future reserved word, set aside for use as a keyword in future language extensions.

Similarly, implements, interface, package, private, protected, and public are future reserved words in strict mode code.

Note 3

The names arguments and eval are not keywords, but they are subject to some restrictions in strict mode code. See 13.1.1, 8.6.4, 15.2.1, 15.5.1, 15.6.1, and 15.8.1.

12.8 Punctuators

Syntax

Punctuator :: OptionalChainingPunctuator OtherPunctuator OptionalChainingPunctuator :: ?. [lookahead ∉ DecimalDigit] OtherPunctuator :: one of { ( ) [ ] . ... ; , < > <= >= == != === !== + - * % ** ++ -- << >> >>> & | ^ ! ~ && || ?? ? : = += -= *= %= **= <<= >>= >>>= &= |= ^= &&= ||= ??= => DivPunctuator :: / /= RightBracePunctuator :: }

12.9 Literals

12.9.1 Null Literals

Syntax

NullLiteral :: null

12.9.2 Boolean Literals

Syntax

BooleanLiteral :: true false

12.9.3 Numeric Literals

Syntax

NumericLiteralSeparator :: _ NumericLiteral :: DecimalLiteral DecimalBigIntegerLiteral NonDecimalIntegerLiteral[+Sep] NonDecimalIntegerLiteral[+Sep] BigIntLiteralSuffix LegacyOctalIntegerLiteral DecimalBigIntegerLiteral :: 0 BigIntLiteralSuffix NonZeroDigit DecimalDigits[+Sep]opt BigIntLiteralSuffix NonZeroDigit NumericLiteralSeparator DecimalDigits[+Sep] BigIntLiteralSuffix NonDecimalIntegerLiteral[Sep] :: BinaryIntegerLiteral[?Sep] OctalIntegerLiteral[?Sep] HexIntegerLiteral[?Sep] BigIntLiteralSuffix :: n DecimalLiteral :: DecimalIntegerLiteral . DecimalDigits[+Sep]opt ExponentPart[+Sep]opt . DecimalDigits[+Sep] ExponentPart[+Sep]opt DecimalIntegerLiteral ExponentPart[+Sep]opt DecimalIntegerLiteral :: 0 NonZeroDigit NonZeroDigit NumericLiteralSeparatoropt DecimalDigits[+Sep] NonOctalDecimalIntegerLiteral DecimalDigits[Sep] :: DecimalDigit DecimalDigits[?Sep] DecimalDigit [+Sep] DecimalDigits[+Sep] NumericLiteralSeparator DecimalDigit DecimalDigit :: one of 0 1 2 3 4 5 6 7 8 9 NonZeroDigit :: one of 1 2 3 4 5 6 7 8 9 ExponentPart[Sep] :: ExponentIndicator SignedInteger[?Sep] ExponentIndicator :: one of e E SignedInteger[Sep] :: DecimalDigits[?Sep] + DecimalDigits[?Sep] - DecimalDigits[?Sep] BinaryIntegerLiteral[Sep] :: 0b BinaryDigits[?Sep] 0B BinaryDigits[?Sep] BinaryDigits[Sep] :: BinaryDigit BinaryDigits[?Sep] BinaryDigit [+Sep] BinaryDigits[+Sep] NumericLiteralSeparator BinaryDigit BinaryDigit :: one of 0 1 OctalIntegerLiteral[Sep] :: 0o OctalDigits[?Sep] 0O OctalDigits[?Sep] OctalDigits[Sep] :: OctalDigit OctalDigits[?Sep] OctalDigit [+Sep] OctalDigits[+Sep] NumericLiteralSeparator OctalDigit LegacyOctalIntegerLiteral :: 0 OctalDigit LegacyOctalIntegerLiteral OctalDigit NonOctalDecimalIntegerLiteral :: 0 NonOctalDigit LegacyOctalLikeDecimalIntegerLiteral NonOctalDigit NonOctalDecimalIntegerLiteral DecimalDigit LegacyOctalLikeDecimalIntegerLiteral :: 0 OctalDigit LegacyOctalLikeDecimalIntegerLiteral OctalDigit OctalDigit :: one of 0 1 2 3 4 5 6 7 NonOctalDigit :: one of 8 9 HexIntegerLiteral[Sep] :: 0x HexDigits[?Sep] 0X HexDigits[?Sep] HexDigits[Sep] :: HexDigit HexDigits[?Sep] HexDigit [+Sep] HexDigits[+Sep] NumericLiteralSeparator HexDigit HexDigit :: one of 0 1 2 3 4 5 6 7 8 9 a b c d e f A B C D E F

The SourceCharacter immediately following a NumericLiteral must not be an IdentifierStart or DecimalDigit.

Note

For example: 3in is an error and not the two input elements 3 and in.

12.9.3.1 Static Semantics: Early Errors

NumericLiteral :: LegacyOctalIntegerLiteral DecimalIntegerLiteral :: NonOctalDecimalIntegerLiteral
  • It is a Syntax Error if IsStrict(this production) is true.
Note
In non-strict code, this syntax is Legacy.

12.9.3.2 Static Semantics: MV

A numeric literal stands for a value of the Number type or the BigInt type.

12.9.3.3 Static Semantics: NumericValue

The syntax-directed operation NumericValue takes no arguments and returns a Number or a BigInt. It is defined piecewise over the following productions:

NumericLiteral :: DecimalLiteral
  1. Return RoundMVResult(MV of DecimalLiteral).
NumericLiteral :: NonDecimalIntegerLiteral
  1. Return 𝔽(MV of NonDecimalIntegerLiteral).
NumericLiteral :: LegacyOctalIntegerLiteral
  1. Return 𝔽(MV of LegacyOctalIntegerLiteral).
NumericLiteral :: NonDecimalIntegerLiteral BigIntLiteralSuffix
  1. Return the BigInt value for the MV of NonDecimalIntegerLiteral.
DecimalBigIntegerLiteral :: 0 BigIntLiteralSuffix
  1. Return 0.
DecimalBigIntegerLiteral :: NonZeroDigit BigIntLiteralSuffix
  1. Return the BigInt value for the MV of NonZeroDigit.
DecimalBigIntegerLiteral :: NonZeroDigit DecimalDigits BigIntLiteralSuffix NonZeroDigit NumericLiteralSeparator DecimalDigits BigIntLiteralSuffix
  1. Let n be the number of code points in DecimalDigits, excluding all occurrences of NumericLiteralSeparator.
  2. Let mv be (the MV of NonZeroDigit × 10n) plus the MV of DecimalDigits.
  3. Return (mv).

12.9.4 String Literals

Note 1

A string literal is 0 or more Unicode code points enclosed in single or double quotes. Unicode code points may also be represented by an escape sequence. All code points may appear literally in a string literal except for the closing quote code points, U+005C (REVERSE SOLIDUS), U+000D (CARRIAGE RETURN), and U+000A (LINE FEED). Any code points may appear in the form of an escape sequence. String literals evaluate to ECMAScript String values. When generating these String values Unicode code points are UTF-16 encoded as defined in 11.1.1. Code points belonging to the Basic Multilingual Plane are encoded as a single code unit element of the string. All other code points are encoded as two code unit elements of the string.

Syntax

StringLiteral :: " DoubleStringCharactersopt " ' SingleStringCharactersopt ' DoubleStringCharacters :: DoubleStringCharacter DoubleStringCharactersopt SingleStringCharacters :: SingleStringCharacter SingleStringCharactersopt DoubleStringCharacter :: SourceCharacter but not one of " or \ or LineTerminator <LS> <PS> \ EscapeSequence LineContinuation SingleStringCharacter :: SourceCharacter but not one of ' or \ or LineTerminator <LS> <PS> \ EscapeSequence LineContinuation LineContinuation :: \ LineTerminatorSequence EscapeSequence :: CharacterEscapeSequence 0 [lookahead ∉ DecimalDigit] LegacyOctalEscapeSequence NonOctalDecimalEscapeSequence HexEscapeSequence UnicodeEscapeSequence CharacterEscapeSequence :: SingleEscapeCharacter NonEscapeCharacter SingleEscapeCharacter :: one of ' " \ b f n r t v NonEscapeCharacter :: SourceCharacter but not one of EscapeCharacter or LineTerminator EscapeCharacter :: SingleEscapeCharacter DecimalDigit x u LegacyOctalEscapeSequence :: 0 [lookahead ∈ { 8, 9 }] NonZeroOctalDigit [lookahead ∉ OctalDigit] ZeroToThree OctalDigit [lookahead ∉ OctalDigit] FourToSeven OctalDigit ZeroToThree OctalDigit OctalDigit NonZeroOctalDigit :: OctalDigit but not 0 ZeroToThree :: one of 0 1 2 3 FourToSeven :: one of 4 5 6 7 NonOctalDecimalEscapeSequence :: one of 8 9 HexEscapeSequence :: x HexDigit HexDigit UnicodeEscapeSequence :: u Hex4Digits u{ CodePoint } Hex4Digits :: HexDigit HexDigit HexDigit HexDigit

The definition of the nonterminal HexDigit is given in 12.9.3. SourceCharacter is defined in 11.1.

Note 2

<LF> and <CR> cannot appear in a string literal, except as part of a LineContinuation to produce the empty code points sequence. The proper way to include either in the String value of a string literal is to use an escape sequence such as \n or \u000A.

12.9.4.1 Static Semantics: Early Errors

EscapeSequence :: LegacyOctalEscapeSequence NonOctalDecimalEscapeSequence
  • It is a Syntax Error if IsStrict(this production) is true.
Note 1
In non-strict code, this syntax is Legacy.
Note 2

It is possible for string literals to precede a Use Strict Directive that places the enclosing code in strict mode, and implementations must take care to enforce the above rules for such literals. For example, the following source text contains a Syntax Error:

function invalid() { "\7"; "use strict"; }

12.9.4.2 Static Semantics: SV

The syntax-directed operation SV takes no arguments and returns a String.

A string literal stands for a value of the String type. SV produces String values for string literals through recursive application on the various parts of the string literal. As part of this process, some Unicode code points within the string literal are interpreted as having a mathematical value, as described below or in 12.9.3.

Table 37: String Single Character Escape Sequences
Escape Sequence Code Unit Value Unicode Character Name Symbol
\b 0x0008 BACKSPACE <BS>
\t 0x0009 CHARACTER TABULATION <HT>
\n 0x000A LINE FEED (LF) <LF>
\v 0x000B LINE TABULATION <VT>
\f 0x000C FORM FEED (FF) <FF>
\r 0x000D CARRIAGE RETURN (CR) <CR>
\" 0x0022 QUOTATION MARK "
\' 0x0027 APOSTROPHE '
\\ 0x005C REVERSE SOLIDUS \

12.9.4.3 Static Semantics: MV

12.9.5 Regular Expression Literals

Note 1

A regular expression literal is an input element that is converted to a RegExp object (see 22.2) each time the literal is evaluated. Two regular expression literals in a program evaluate to regular expression objects that never compare as === to each other even if the two literals' contents are identical. A RegExp object may also be created at runtime by new RegExp or calling the RegExp constructor as a function (see 22.2.4).

The productions below describe the syntax for a regular expression literal and are used by the input element scanner to find the end of the regular expression literal. The source text comprising the RegularExpressionBody and the RegularExpressionFlags are subsequently parsed again using the more stringent ECMAScript Regular Expression grammar (22.2.1).

An implementation may extend the ECMAScript Regular Expression grammar defined in 22.2.1, but it must not extend the RegularExpressionBody and RegularExpressionFlags productions defined below or the productions used by these productions.

Syntax

RegularExpressionLiteral :: / RegularExpressionBody / RegularExpressionFlags RegularExpressionBody :: RegularExpressionFirstChar RegularExpressionChars RegularExpressionChars :: [empty] RegularExpressionChars RegularExpressionChar RegularExpressionFirstChar :: RegularExpressionNonTerminator but not one of * or \ or / or [ RegularExpressionBackslashSequence RegularExpressionClass RegularExpressionChar :: RegularExpressionNonTerminator but not one of \ or / or [ RegularExpressionBackslashSequence RegularExpressionClass RegularExpressionBackslashSequence :: \ RegularExpressionNonTerminator RegularExpressionNonTerminator :: SourceCharacter but not LineTerminator RegularExpressionClass :: [ RegularExpressionClassChars ] RegularExpressionClassChars :: [empty] RegularExpressionClassChars RegularExpressionClassChar RegularExpressionClassChar :: RegularExpressionNonTerminator but not one of ] or \ RegularExpressionBackslashSequence RegularExpressionFlags :: [empty] RegularExpressionFlags IdentifierPartChar Note 2

Regular expression literals may not be empty; instead of representing an empty regular expression literal, the code unit sequence // starts a single-line comment. To specify an empty regular expression, use: /(?:)/.

12.9.5.1 Static Semantics: BodyText

The syntax-directed operation BodyText takes no arguments and returns source text. It is defined piecewise over the following productions:

RegularExpressionLiteral :: / RegularExpressionBody / RegularExpressionFlags
  1. Return the source text that was recognized as RegularExpressionBody.

12.9.5.2 Static Semantics: FlagText

The syntax-directed operation FlagText takes no arguments and returns source text. It is defined piecewise over the following productions:

RegularExpressionLiteral :: / RegularExpressionBody / RegularExpressionFlags
  1. Return the source text that was recognized as RegularExpressionFlags.

12.9.6 Template Literal Lexical Components

Syntax

Template :: NoSubstitutionTemplate TemplateHead NoSubstitutionTemplate :: ` TemplateCharactersopt ` TemplateHead :: ` TemplateCharactersopt ${ TemplateSubstitutionTail :: TemplateMiddle TemplateTail TemplateMiddle :: } TemplateCharactersopt ${ TemplateTail :: } TemplateCharactersopt ` TemplateCharacters :: TemplateCharacter TemplateCharactersopt TemplateCharacter :: $ [lookahead ≠ {] \ TemplateEscapeSequence \ NotEscapeSequence LineContinuation LineTerminatorSequence SourceCharacter but not one of ` or \ or $ or LineTerminator TemplateEscapeSequence :: CharacterEscapeSequence 0 [lookahead ∉ DecimalDigit] HexEscapeSequence UnicodeEscapeSequence NotEscapeSequence :: 0 DecimalDigit DecimalDigit but not 0 x [lookahead ∉ HexDigit] x HexDigit [lookahead ∉ HexDigit] u [lookahead ∉ HexDigit] [lookahead ≠ {] u HexDigit [lookahead ∉ HexDigit] u HexDigit HexDigit [lookahead ∉ HexDigit] u HexDigit HexDigit HexDigit [lookahead ∉ HexDigit] u { [lookahead ∉ HexDigit] u { NotCodePoint [lookahead ∉ HexDigit] u { CodePoint [lookahead ∉ HexDigit] [lookahead ≠ }] NotCodePoint :: HexDigits[~Sep] but only if the MV of HexDigits > 0x10FFFF CodePoint :: HexDigits[~Sep] but only if the MV of HexDigits ≤ 0x10FFFF Note

TemplateSubstitutionTail is used by the InputElementTemplateTail alternative lexical goal.

12.9.6.1 Static Semantics: TV

The syntax-directed operation TV takes no arguments and returns a String or undefined. A template literal component is interpreted by TV as a value of the String type. TV is used to construct the indexed components of a template object (colloquially, the template values). In TV, escape sequences are replaced by the UTF-16 code unit(s) of the Unicode code point represented by the escape sequence.

12.9.6.2 Static Semantics: TRV

The syntax-directed operation TRV takes no arguments and returns a String. A template literal component is interpreted by TRV as a value of the String type. TRV is used to construct the raw components of a template object (colloquially, the template raw values). TRV is similar to TV with the difference being that in TRV, escape sequences are interpreted as they appear in the literal.

Note

TV excludes the code units of LineContinuation while TRV includes them. <CR><LF> and <CR> LineTerminatorSequences are normalized to <LF> for both TV and TRV. An explicit TemplateEscapeSequence is needed to include a <CR> or <CR><LF> sequence.

12.10 Automatic Semicolon Insertion

Most ECMAScript statements and declarations must be terminated with a semicolon. Such semicolons may always appear explicitly in the source text. For convenience, however, such semicolons may be omitted from the source text in certain situations. These situations are described by saying that semicolons are automatically inserted into the source code token stream in those situations.

12.10.1 Rules of Automatic Semicolon Insertion

In the following rules, “token” means the actual recognized lexical token determined using the current lexical goal symbol as described in clause 12.

There are three basic rules of semicolon insertion:

  1. When, as the source text is parsed from left to right, a token (called the offending token) is encountered that is not allowed by any production of the grammar, then a semicolon is automatically inserted before the offending token if one or more of the following conditions is true:

    • The offending token is separated from the previous token by at least one LineTerminator.
    • The offending token is }.
    • The previous token is ) and the inserted semicolon would then be parsed as the terminating semicolon of a do-while statement (14.7.2).
  2. When, as the source text is parsed from left to right, the end of the input stream of tokens is encountered and the parser is unable to parse the input token stream as a single instance of the goal nonterminal, then a semicolon is automatically inserted at the end of the input stream.
  3. When, as the source text is parsed from left to right, a token is encountered that is allowed by some production of the grammar, but the production is a restricted production and the token would be the first token for a terminal or nonterminal immediately following the annotation “[no LineTerminator here]” within the restricted production (and therefore such a token is called a restricted token), and the restricted token is separated from the previous token by at least one LineTerminator, then a semicolon is automatically inserted before the restricted token.

However, there is an additional overriding condition on the preceding rules: a semicolon is never inserted automatically if the semicolon would then be parsed as an empty statement or if that semicolon would become one of the two semicolons in the header of a for statement (see 14.7.4).

Note

The following are the only restricted productions in the grammar:

UpdateExpression[Yield, Await] : LeftHandSideExpression[?Yield, ?Await] [no LineTerminator here] ++ LeftHandSideExpression[?Yield, ?Await] [no LineTerminator here] -- ContinueStatement[Yield, Await] : continue ; continue [no LineTerminator here] LabelIdentifier[?Yield, ?Await] ; BreakStatement[Yield, Await] : break ; break [no LineTerminator here] LabelIdentifier[?Yield, ?Await] ; ReturnStatement[Yield, Await] : return ; return [no LineTerminator here] Expression[+In, ?Yield, ?Await] ; ThrowStatement[Yield, Await] : throw [no LineTerminator here] Expression[+In, ?Yield, ?Await] ; YieldExpression[In, Await] : yield yield [no LineTerminator here] AssignmentExpression[?In, +Yield, ?Await] yield [no LineTerminator here] * AssignmentExpression[?In, +Yield, ?Await] ArrowFunction[In, Yield, Await] : ArrowParameters[?Yield, ?Await] [no LineTerminator here] => ConciseBody[?In] AsyncFunctionDeclaration[Yield, Await, Default] : async [no LineTerminator here] function BindingIdentifier[?Yield, ?Await] ( FormalParameters[~Yield, +Await] ) { AsyncFunctionBody } [+Default] async [no LineTerminator here] function ( FormalParameters[~Yield, +Await] ) { AsyncFunctionBody } AsyncFunctionExpression : async [no LineTerminator here] function BindingIdentifier[~Yield, +Await]opt ( FormalParameters[~Yield, +Await] ) { AsyncFunctionBody } AsyncMethod[Yield, Await] : async [no LineTerminator here] ClassElementName[?Yield, ?Await] ( UniqueFormalParameters[~Yield, +Await] ) { AsyncFunctionBody } AsyncGeneratorDeclaration[Yield, Await, Default] : async [no LineTerminator here] function * BindingIdentifier[?Yield, ?Await] ( FormalParameters[+Yield, +Await] ) { AsyncGeneratorBody } [+Default] async [no LineTerminator here] function * ( FormalParameters[+Yield, +Await] ) { AsyncGeneratorBody } AsyncGeneratorExpression : async [no LineTerminator here] function * BindingIdentifier[+Yield, +Await]opt ( FormalParameters[+Yield, +Await] ) { AsyncGeneratorBody } AsyncGeneratorMethod[Yield, Await] : async [no LineTerminator here] * ClassElementName[?Yield, ?Await] ( UniqueFormalParameters[+Yield, +Await] ) { AsyncGeneratorBody } AsyncArrowFunction[In, Yield, Await] : async [no LineTerminator here] AsyncArrowBindingIdentifier[?Yield] [no LineTerminator here] => AsyncConciseBody[?In] CoverCallExpressionAndAsyncArrowHead[?Yield, ?Await] [no LineTerminator here] => AsyncConciseBody[?In] AsyncArrowHead : async [no LineTerminator here] ArrowFormalParameters[~Yield, +Await]

The practical effect of these restricted productions is as follows:

  • When a ++ or -- token is encountered where the parser would treat it as a postfix operator, and at least one LineTerminator occurred between the preceding token and the ++ or -- token, then a semicolon is automatically inserted before the ++ or -- token.
  • When a continue, break, return, throw, or yield token is encountered and a LineTerminator is encountered before the next token, a semicolon is automatically inserted after the continue, break, return, throw, or yield token.
  • When arrow function parameter(s) are followed by a LineTerminator before a => token, a semicolon is automatically inserted and the punctuator causes a syntax error.
  • When an async token is followed by a LineTerminator before a function or IdentifierName or ( token, a semicolon is automatically inserted and the async token is not treated as part of the same expression or class element as the following tokens.
  • When an async token is followed by a LineTerminator before a * token, a semicolon is automatically inserted and the punctuator causes a syntax error.

The resulting practical advice to ECMAScript programmers is:

  • A postfix ++ or -- operator should be on the same line as its operand.
  • An Expression in a return or throw statement or an AssignmentExpression in a yield expression should start on the same line as the return, throw, or yield token.
  • A LabelIdentifier in a break or continue statement should be on the same line as the break or continue token.
  • The end of an arrow function's parameter(s) and its => should be on the same line.
  • The async token preceding an asynchronous function or method should be on the same line as the immediately following token.

12.10.2 Examples of Automatic Semicolon Insertion

This section is non-normative.

The source

{ 1 2 } 3

is not a valid sentence in the ECMAScript grammar, even with the automatic semicolon insertion rules. In contrast, the source

{ 1
2 } 3

is also not a valid ECMAScript sentence, but is transformed by automatic semicolon insertion into the following:

{ 1
;2 ;} 3;

which is a valid ECMAScript sentence.

The source

for (a; b
)

is not a valid ECMAScript sentence and is not altered by automatic semicolon insertion because the semicolon is needed for the header of a for statement. Automatic semicolon insertion never inserts one of the two semicolons in the header of a for statement.

The source

return
a + b

is transformed by automatic semicolon insertion into the following:

return;
a + b;
Note 1

The expression a + b is not treated as a value to be returned by the return statement, because a LineTerminator separates it from the token return.

The source

a = b
++c

is transformed by automatic semicolon insertion into the following:

a = b;
++c;
Note 2

The token ++ is not treated as a postfix operator applying to the variable b, because a LineTerminator occurs between b and ++.

The source

if (a > b)
else c = d

is not a valid ECMAScript sentence and is not altered by automatic semicolon insertion before the else token, even though no production of the grammar applies at that point, because an automatically inserted semicolon would then be parsed as an empty statement.

The source

a = b + c
(d + e).print()

is not transformed by automatic semicolon insertion, because the parenthesized expression that begins the second line can be interpreted as an argument list for a function call:

a = b + c(d + e).print()

In the circumstance that an assignment statement must begin with a left parenthesis, it is a good idea for the programmer to provide an explicit semicolon at the end of the preceding statement rather than to rely on automatic semicolon insertion.

12.10.3 Interesting Cases of Automatic Semicolon Insertion

This section is non-normative.

ECMAScript programs can be written in a style with very few semicolons by relying on automatic semicolon insertion. As described above, semicolons are not inserted at every newline, and automatic semicolon insertion can depend on multiple tokens across line terminators.

As new syntactic features are added to ECMAScript, additional grammar productions could be added that cause lines relying on automatic semicolon insertion preceding them to change grammar productions when parsed.

For the purposes of this section, a case of automatic semicolon insertion is considered interesting if it is a place where a semicolon may or may not be inserted, depending on the source text which precedes it. The rest of this section describes a number of interesting cases of automatic semicolon insertion in this version of ECMAScript.

12.10.3.1 Interesting Cases of Automatic Semicolon Insertion in Statement Lists

In a StatementList, many StatementListItems end in semicolons, which may be omitted using automatic semicolon insertion. As a consequence of the rules above, at the end of a line ending an expression, a semicolon is required if the following line begins with any of the following:

  • An opening parenthesis ((). Without a semicolon, the two lines together are treated as a CallExpression.
  • An opening square bracket ([). Without a semicolon, the two lines together are treated as property access, rather than an ArrayLiteral or ArrayAssignmentPattern.
  • A template literal (`). Without a semicolon, the two lines together are interpreted as a tagged Template (13.3.11), with the previous expression as the MemberExpression.
  • Unary + or -. Without a semicolon, the two lines together are interpreted as a usage of the corresponding binary operator.
  • A RegExp literal. Without a semicolon, the two lines together may be parsed instead as the / MultiplicativeOperator, for example if the RegExp has flags.

12.10.3.2 Cases of Automatic Semicolon Insertion and “[no LineTerminator here]”

This section is non-normative.

ECMAScript contains grammar productions which include “[no LineTerminator here]”. These productions are sometimes a means to have optional operands in the grammar. Introducing a LineTerminator in these locations would change the grammar production of a source text by using the grammar production without the optional operand.

The rest of this section describes a number of productions using “[no LineTerminator here]” in this version of ECMAScript.

12.10.3.2.1 List of Grammar Productions with Optional Operands and “[no LineTerminator here]”

13 ECMAScript Language: Expressions

13.1 Identifiers

Syntax

IdentifierReference[Yield, Await] : Identifier [~Yield] yield [~Await] await BindingIdentifier[Yield, Await] : Identifier yield await LabelIdentifier[Yield, Await] : Identifier [~Yield] yield [~Await] await Identifier : IdentifierName but not ReservedWord Note

yield and await are permitted as BindingIdentifier in the grammar, and prohibited with static semantics below, to prohibit automatic semicolon insertion in cases such as

let
await 0;

13.1.1 Static Semantics: Early Errors

BindingIdentifier : Identifier IdentifierReference : yield BindingIdentifier : yield LabelIdentifier : yield
  • It is a Syntax Error if IsStrict(this production) is true.
IdentifierReference : await BindingIdentifier : await LabelIdentifier : await BindingIdentifier[Yield, Await] : yield
  • It is a Syntax Error if this production has a [Yield] parameter.
BindingIdentifier[Yield, Await] : await
  • It is a Syntax Error if this production has an [Await] parameter.
IdentifierReference[Yield, Await] : Identifier BindingIdentifier[Yield, Await] : Identifier LabelIdentifier[Yield, Await] : Identifier
  • It is a Syntax Error if this production has a [Yield] parameter and the StringValue of Identifier is "yield".
  • It is a Syntax Error if this production has an [Await] parameter and the StringValue of Identifier is "await".
Identifier : IdentifierName but not ReservedWord Note

The StringValue of IdentifierName normalizes any Unicode escape sequences in IdentifierName hence such escapes cannot be used to write an Identifier whose code point sequence is the same as a ReservedWord.

13.1.2 Static Semantics: StringValue

The syntax-directed operation StringValue takes no arguments and returns a String. It is defined piecewise over the following productions:

IdentifierName :: IdentifierStart IdentifierName IdentifierPart
  1. Let idTextUnescaped be the IdentifierCodePoints of IdentifierName.
  2. Return CodePointsToString(idTextUnescaped).
IdentifierReference : yield BindingIdentifier : yield LabelIdentifier : yield
  1. Return "yield".
IdentifierReference : await BindingIdentifier : await LabelIdentifier : await
  1. Return "await".
Identifier : IdentifierName but not ReservedWord
  1. Return the StringValue of IdentifierName.
PrivateIdentifier :: # IdentifierName
  1. Return the string-concatenation of 0x0023 (NUMBER SIGN) and the StringValue of IdentifierName.
ModuleExportName : StringLiteral
  1. Return the SV of StringLiteral.

13.1.3 Runtime Semantics: Evaluation

IdentifierReference : Identifier
  1. Return ? ResolveBinding(StringValue of Identifier).
IdentifierReference : yield
  1. Return ? ResolveBinding("yield").
IdentifierReference : await
  1. Return ? ResolveBinding("await").
Note 1

The result of evaluating an IdentifierReference is always a value of type Reference.

Note 2

In non-strict code, the keyword yield may be used as an identifier. Evaluating the IdentifierReference resolves the binding of yield as if it was an Identifier. Early Error restriction ensures that such an evaluation only can occur for non-strict code.

13.2 Primary Expression

Syntax

PrimaryExpression[Yield, Await] : this IdentifierReference[?Yield, ?Await] Literal ArrayLiteral[?Yield, ?Await] ObjectLiteral[?Yield, ?Await] FunctionExpression ClassExpression[?Yield, ?Await] GeneratorExpression AsyncFunctionExpression AsyncGeneratorExpression RegularExpressionLiteral TemplateLiteral[?Yield, ?Await, ~Tagged] CoverParenthesizedExpressionAndArrowParameterList[?Yield, ?Await] CoverParenthesizedExpressionAndArrowParameterList[Yield, Await] : ( Expression[+In, ?Yield, ?Await] ) ( Expression[+In, ?Yield, ?Await] , ) ( ) ( ... BindingIdentifier[?Yield, ?Await] ) ( ... BindingPattern[?Yield, ?Await] ) ( Expression[+In, ?Yield, ?Await] , ... BindingIdentifier[?Yield, ?Await] ) ( Expression[+In, ?Yield, ?Await] , ... BindingPattern[?Yield, ?Await] )

Supplemental Syntax

When processing an instance of the production
PrimaryExpression[Yield, Await] : CoverParenthesizedExpressionAndArrowParameterList[?Yield, ?Await]
the interpretation of CoverParenthesizedExpressionAndArrowParameterList is refined using the following grammar:

ParenthesizedExpression[Yield, Await] : ( Expression[+In, ?Yield, ?Await] )

13.2.1 The this Keyword

13.2.1.1 Runtime Semantics: Evaluation

PrimaryExpression : this
  1. Return ? ResolveThisBinding().

13.2.2 Identifier Reference

See 13.1 for IdentifierReference.

13.2.3 Literals

Syntax

Literal : NullLiteral BooleanLiteral NumericLiteral StringLiteral

13.2.3.1 Runtime Semantics: Evaluation

Literal : NullLiteral
  1. Return null.
Literal : BooleanLiteral
  1. If BooleanLiteral is the token false, return false.
  2. If BooleanLiteral is the token true, return true.
Literal : NumericLiteral
  1. Return the NumericValue of NumericLiteral as defined in 12.9.3.
Literal : StringLiteral
  1. Return the SV of StringLiteral as defined in 12.9.4.2.

13.2.4 Array Initializer

Note

An ArrayLiteral is an expression describing the initialization of an Array, using a list, of zero or more expressions each of which represents an array element, enclosed in square brackets. The elements need not be literals; they are evaluated each time the array initializer is evaluated.

Array elements may be elided at the beginning, middle or end of the element list. Whenever a comma in the element list is not preceded by an AssignmentExpression (i.e., a comma at the beginning or after another comma), the missing array element contributes to the length of the Array and increases the index of subsequent elements. Elided array elements are not defined. If an element is elided at the end of an array, that element does not contribute to the length of the Array.

Syntax

ArrayLiteral[Yield, Await] : [ Elisionopt ] [ ElementList[?Yield, ?Await] ] [ ElementList[?Yield, ?Await] , Elisionopt ] ElementList[Yield, Await] : Elisionopt AssignmentExpression[+In, ?Yield, ?Await] Elisionopt SpreadElement[?Yield, ?Await] ElementList[?Yield, ?Await] , Elisionopt AssignmentExpression[+In, ?Yield, ?Await] ElementList[?Yield, ?Await] , Elisionopt SpreadElement[?Yield, ?Await] Elision : , Elision , SpreadElement[Yield, Await] : ... AssignmentExpression[+In, ?Yield, ?Await]

13.2.4.1 Runtime Semantics: ArrayAccumulation

The syntax-directed operation ArrayAccumulation takes arguments array (an Array) and nextIndex (an integer) and returns either a normal completion containing an integer or an abrupt completion. It is defined piecewise over the following productions:

Elision : ,
  1. Let len be nextIndex + 1.
  2. Perform ? Set(array, "length", 𝔽(len), true).
  3. NOTE: The above step throws if len exceeds 232 - 1.
  4. Return len.
Elision : Elision ,
  1. Return ? ArrayAccumulation of Elision with arguments array and (nextIndex + 1).
ElementList : Elisionopt AssignmentExpression
  1. If Elision is present, then
    1. Set nextIndex to ? ArrayAccumulation of Elision with arguments array and nextIndex.
  2. Let initResult be ? Evaluation of AssignmentExpression.
  3. Let initValue be ? GetValue(initResult).
  4. Perform ! CreateDataPropertyOrThrow(array, ! ToString(𝔽(nextIndex)), initValue).
  5. Return nextIndex + 1.
ElementList : Elisionopt SpreadElement
  1. If Elision is present, then
    1. Set nextIndex to ? ArrayAccumulation of Elision with arguments array and nextIndex.
  2. Return ? ArrayAccumulation of SpreadElement with arguments array and nextIndex.
ElementList : ElementList , Elisionopt AssignmentExpression
  1. Set nextIndex to ? ArrayAccumulation of ElementList with arguments array and nextIndex.
  2. If Elision is present, then
    1. Set nextIndex to ? ArrayAccumulation of Elision with arguments array and nextIndex.
  3. Let initResult be ? Evaluation of AssignmentExpression.
  4. Let initValue be ? GetValue(initResult).
  5. Perform ! CreateDataPropertyOrThrow(array, ! ToString(𝔽(nextIndex)), initValue).
  6. Return nextIndex + 1.
ElementList : ElementList , Elisionopt SpreadElement
  1. Set nextIndex to ? ArrayAccumulation of ElementList with arguments array and nextIndex.
  2. If Elision is present, then
    1. Set nextIndex to ? ArrayAccumulation of Elision with arguments array and nextIndex.
  3. Return ? ArrayAccumulation of SpreadElement with arguments array and nextIndex.
SpreadElement : ... AssignmentExpression
  1. Let spreadRef be ? Evaluation of AssignmentExpression.
  2. Let spreadObj be ? GetValue(spreadRef).
  3. Let iteratorRecord be ? GetIterator(spreadObj, sync).
  4. Repeat,
    1. Let next be ? IteratorStepValue(iteratorRecord).
    2. If next is done, return nextIndex.
    3. Perform ! CreateDataPropertyOrThrow(array, ! ToString(𝔽(nextIndex)), next).
    4. Set nextIndex to nextIndex + 1.
Note

CreateDataPropertyOrThrow is used to ensure that own properties are defined for the array even if the standard built-in Array prototype object has been modified in a manner that would preclude the creation of new own properties using [[Set]].

13.2.4.2 Runtime Semantics: Evaluation

ArrayLiteral : [ Elisionopt ]
  1. Let array be ! ArrayCreate(0).
  2. If Elision is present, then
    1. Perform ? ArrayAccumulation of Elision with arguments array and 0.
  3. Return array.
ArrayLiteral : [ ElementList ]
  1. Let array be ! ArrayCreate(0).
  2. Perform ? ArrayAccumulation of ElementList with arguments array and 0.
  3. Return array.
ArrayLiteral : [ ElementList , Elisionopt ]
  1. Let array be ! ArrayCreate(0).
  2. Let nextIndex be ? ArrayAccumulation of ElementList with arguments array and 0.
  3. If Elision is present, then
    1. Perform ? ArrayAccumulation of Elision with arguments array and nextIndex.
  4. Return array.

13.2.5 Object Initializer

Note 1

An object initializer is an expression describing the initialization of an Object, written in a form resembling a literal. It is a list of zero or more pairs of property keys and associated values, enclosed in curly brackets. The values need not be literals; they are evaluated each time the object initializer is evaluated.

Syntax

ObjectLiteral[Yield, Await] : { } { PropertyDefinitionList[?Yield, ?Await] } { PropertyDefinitionList[?Yield, ?Await] , } PropertyDefinitionList[Yield, Await] : PropertyDefinition[?Yield, ?Await] PropertyDefinitionList[?Yield, ?Await] , PropertyDefinition[?Yield, ?Await] PropertyDefinition[Yield, Await] : IdentifierReference[?Yield, ?Await] CoverInitializedName[?Yield, ?Await] PropertyName[?Yield, ?Await] : AssignmentExpression[+In, ?Yield, ?Await] MethodDefinition[?Yield, ?Await] ... AssignmentExpression[+In, ?Yield, ?Await] PropertyName[Yield, Await] : LiteralPropertyName ComputedPropertyName[?Yield, ?Await] LiteralPropertyName : IdentifierName StringLiteral NumericLiteral ComputedPropertyName[Yield, Await] : [ AssignmentExpression[+In, ?Yield, ?Await] ] CoverInitializedName[Yield, Await] : IdentifierReference[?Yield, ?Await] Initializer[+In, ?Yield, ?Await] Initializer[In, Yield, Await] : = AssignmentExpression[?In, ?Yield, ?Await] Note 2

MethodDefinition is defined in 15.4.

Note 3

In certain contexts, ObjectLiteral is used as a cover grammar for a more restricted secondary grammar. The CoverInitializedName production is necessary to fully cover these secondary grammars. However, use of this production results in an early Syntax Error in normal contexts where an actual ObjectLiteral is expected.

13.2.5.1 Static Semantics: Early Errors

PropertyDefinition : MethodDefinition

In addition to describing an actual object initializer the ObjectLiteral productions are also used as a cover grammar for ObjectAssignmentPattern and may be recognized as part of a CoverParenthesizedExpressionAndArrowParameterList. When ObjectLiteral appears in a context where ObjectAssignmentPattern is required the following Early Error rules are not applied. In addition, they are not applied when initially parsing a CoverParenthesizedExpressionAndArrowParameterList or CoverCallExpressionAndAsyncArrowHead.

PropertyDefinition : CoverInitializedName
  • It is a Syntax Error if any source text is matched by this production.
Note 1

This production exists so that ObjectLiteral can serve as a cover grammar for ObjectAssignmentPattern. It cannot occur in an actual object initializer.

ObjectLiteral : { PropertyDefinitionList } { PropertyDefinitionList , } Note 2

The List returned by PropertyNameList does not include property names defined using a ComputedPropertyName.

13.2.5.2 Static Semantics: IsComputedPropertyKey

The syntax-directed operation IsComputedPropertyKey takes no arguments and returns a Boolean. It is defined piecewise over the following productions:

PropertyName : LiteralPropertyName
  1. Return false.
PropertyName : ComputedPropertyName
  1. Return true.

13.2.5.3 Static Semantics: PropertyNameList

The syntax-directed operation PropertyNameList takes no arguments and returns a List of Strings. It is defined piecewise over the following productions:

PropertyDefinitionList : PropertyDefinition
  1. Let propName be the PropName of PropertyDefinition.
  2. If propName is empty, return a new empty List.
  3. Return « propName ».
PropertyDefinitionList : PropertyDefinitionList , PropertyDefinition
  1. Let list be the PropertyNameList of PropertyDefinitionList.
  2. Let propName be the PropName of PropertyDefinition.
  3. If propName is empty, return list.
  4. Return the list-concatenation of list and « propName ».

13.2.5.4 Runtime Semantics: Evaluation

ObjectLiteral : { }
  1. Return OrdinaryObjectCreate(%Object.prototype%).
ObjectLiteral : { PropertyDefinitionList } { PropertyDefinitionList , }
  1. Let obj be OrdinaryObjectCreate(%Object.prototype%).
  2. Perform ? PropertyDefinitionEvaluation of PropertyDefinitionList with argument obj.
  3. Return obj.
LiteralPropertyName : IdentifierName
  1. Return the StringValue of IdentifierName.
LiteralPropertyName : StringLiteral
  1. Return the SV of StringLiteral.
LiteralPropertyName : NumericLiteral
  1. Let nbr be the NumericValue of NumericLiteral.
  2. Return ! ToString(nbr).
ComputedPropertyName : [ AssignmentExpression ]
  1. Let exprValue be ? Evaluation of AssignmentExpression.
  2. Let propName be ? GetValue(exprValue).
  3. Return ? ToPropertyKey(propName).

13.2.5.5 Runtime Semantics: PropertyDefinitionEvaluation

The syntax-directed operation PropertyDefinitionEvaluation takes argument object (an Object) and returns either a normal completion containing unused or an abrupt completion. It is defined piecewise over the following productions:

PropertyDefinitionList : PropertyDefinitionList , PropertyDefinition
  1. Perform ? PropertyDefinitionEvaluation of PropertyDefinitionList with argument object.
  2. Perform ? PropertyDefinitionEvaluation of PropertyDefinition with argument object.
  3. Return unused.
PropertyDefinition : ... AssignmentExpression
  1. Let exprValue be ? Evaluation of AssignmentExpression.
  2. Let fromValue be ? GetValue(exprValue).
  3. Let excludedNames be a new empty List.
  4. Perform ? CopyDataProperties(object, fromValue, excludedNames).
  5. Return unused.
PropertyDefinition : IdentifierReference
  1. Let propName be the StringValue of IdentifierReference.
  2. Let exprValue be ? Evaluation of IdentifierReference.
  3. Let propValue be ? GetValue(exprValue).
  4. Assert: object is an ordinary, extensible object with no non-configurable properties.
  5. Perform ! CreateDataPropertyOrThrow(object, propName, propValue).
  6. Return unused.
PropertyDefinition : PropertyName : AssignmentExpression
  1. Let propKey be ? Evaluation of PropertyName.
  2. If this PropertyDefinition is contained within a Script that is being evaluated for ParseJSON (see step 6 of ParseJSON), then
    1. Let isProtoSetter be false.
  3. Else if propKey is "__proto__" and IsComputedPropertyKey of PropertyName is false, then
    1. Let isProtoSetter be true.
  4. Else,
    1. Let isProtoSetter be false.
  5. If IsAnonymousFunctionDefinition(AssignmentExpression) is true and isProtoSetter is false, then
    1. Let propValue be ? NamedEvaluation of AssignmentExpression with argument propKey.
  6. Else,
    1. Let exprValueRef be ? Evaluation of AssignmentExpression.
    2. Let propValue be ? GetValue(exprValueRef).
  7. If isProtoSetter is true, then
    1. If propValue is an Object or propValue is null, then
      1. Perform ! object.[[SetPrototypeOf]](propValue).
    2. Return unused.
  8. Assert: object is an ordinary, extensible object with no non-configurable properties.
  9. Perform ! CreateDataPropertyOrThrow(object, propKey, propValue).
  10. Return unused.
PropertyDefinition : MethodDefinition
  1. Perform ? MethodDefinitionEvaluation of MethodDefinition with arguments object and true.
  2. Return unused.

13.2.6 Function Defining Expressions

See 15.2 for PrimaryExpression : FunctionExpression .

See 15.5 for PrimaryExpression : GeneratorExpression .

See 15.7 for PrimaryExpression : ClassExpression .

See 15.8 for PrimaryExpression : AsyncFunctionExpression .

See 15.6 for PrimaryExpression : AsyncGeneratorExpression .

13.2.7 Regular Expression Literals

Syntax

See 12.9.5.

13.2.7.1 Static Semantics: Early Errors

PrimaryExpression : RegularExpressionLiteral

13.2.7.2 Static Semantics: IsValidRegularExpressionLiteral ( literal )

The abstract operation IsValidRegularExpressionLiteral takes argument literal (a RegularExpressionLiteral Parse Node) and returns a Boolean. It determines if its argument is a valid regular expression literal. It performs the following steps when called:

  1. Let flags be the FlagText of literal.
  2. If flags contains any code points other than d, g, i, m, s, u, v, or y, or if flags contains any code point more than once, return false.
  3. If flags contains u, let u be true; else let u be false.
  4. If flags contains v, let v be true; else let v be false.
  5. Let patternText be the BodyText of literal.
  6. If u is false and v is false, then
    1. Let stringValue be CodePointsToString(patternText).
    2. Set patternText to the sequence of code points resulting from interpreting each of the 16-bit elements of stringValue as a Unicode BMP code point. UTF-16 decoding is not applied to the elements.
  7. Let parseResult be ParsePattern(patternText, u, v).
  8. If parseResult is a Parse Node, return true; else return false.

13.2.7.3 Runtime Semantics: Evaluation

PrimaryExpression : RegularExpressionLiteral
  1. Let pattern be CodePointsToString(BodyText of RegularExpressionLiteral).
  2. Let flags be CodePointsToString(FlagText of RegularExpressionLiteral).
  3. Return ! RegExpCreate(pattern, flags).

13.2.8 Template Literals

Syntax

TemplateLiteral[Yield, Await, Tagged] : NoSubstitutionTemplate SubstitutionTemplate[?Yield, ?Await, ?Tagged] SubstitutionTemplate[Yield, Await, Tagged] : TemplateHead Expression[+In, ?Yield, ?Await] TemplateSpans[?Yield, ?Await, ?Tagged] TemplateSpans[Yield, Await, Tagged] : TemplateTail TemplateMiddleList[?Yield, ?Await, ?Tagged] TemplateTail TemplateMiddleList[Yield, Await, Tagged] : TemplateMiddle Expression[+In, ?Yield, ?Await] TemplateMiddleList[?Yield, ?Await, ?Tagged] TemplateMiddle Expression[+In, ?Yield, ?Await]

13.2.8.1 Static Semantics: Early Errors

TemplateLiteral[Yield, Await, Tagged] : NoSubstitutionTemplate TemplateLiteral[Yield, Await, Tagged] : SubstitutionTemplate[?Yield, ?Await, ?Tagged] SubstitutionTemplate[Yield, Await, Tagged] : TemplateHead Expression[+In, ?Yield, ?Await] TemplateSpans[?Yield, ?Await, ?Tagged] TemplateSpans[Yield, Await, Tagged] : TemplateTail TemplateMiddleList[Yield, Await, Tagged] : TemplateMiddle Expression[+In, ?Yield, ?Await] TemplateMiddleList[?Yield, ?Await, ?Tagged] TemplateMiddle Expression[+In, ?Yield, ?Await]

13.2.8.2 Static Semantics: TemplateStrings

The syntax-directed operation TemplateStrings takes argument raw (a Boolean) and returns a List of either Strings or undefined. It is defined piecewise over the following productions:

TemplateLiteral : NoSubstitutionTemplate
  1. Return « TemplateString(NoSubstitutionTemplate, raw) ».
SubstitutionTemplate : TemplateHead Expression TemplateSpans
  1. Let head be « TemplateString(TemplateHead, raw) ».
  2. Let tail be the TemplateStrings of TemplateSpans with argument raw.
  3. Return the list-concatenation of head and tail.
TemplateSpans : TemplateTail
  1. Return « TemplateString(TemplateTail, raw) ».
TemplateSpans : TemplateMiddleList TemplateTail
  1. Let middle be the TemplateStrings of TemplateMiddleList with argument raw.
  2. Let tail be « TemplateString(TemplateTail, raw) ».
  3. Return the list-concatenation of middle and tail.
TemplateMiddleList : TemplateMiddle Expression
  1. Return « TemplateString(TemplateMiddle, raw) ».
TemplateMiddleList : TemplateMiddleList TemplateMiddle Expression
  1. Let front be the TemplateStrings of TemplateMiddleList with argument raw.
  2. Let last be « TemplateString(TemplateMiddle, raw) ».
  3. Return the list-concatenation of front and last.

13.2.8.3 Static Semantics: TemplateString ( templateToken, raw )

The abstract operation TemplateString takes arguments templateToken (a NoSubstitutionTemplate Parse Node, a TemplateHead Parse Node, a TemplateMiddle Parse Node, or a TemplateTail Parse Node) and raw (a Boolean) and returns a String or undefined. It performs the following steps when called:

  1. If raw is true, then
    1. Let string be the TRV of templateToken.
  2. Else,
    1. Let string be the TV of templateToken.
  3. Return string.
Note

This operation returns undefined if raw is false and templateToken contains a NotEscapeSequence. In all other cases, it returns a String.

13.2.8.4 GetTemplateObject ( templateLiteral )

The abstract operation GetTemplateObject takes argument templateLiteral (a Parse Node) and returns an Array. It performs the following steps when called:

  1. Let realm be the current Realm Record.
  2. Let templateRegistry be realm.[[TemplateMap]].
  3. For each element e of templateRegistry, do
    1. If e.[[Site]] is the same Parse Node as templateLiteral, then
      1. Return e.[[Array]].
  4. Let rawStrings be the TemplateStrings of templateLiteral with argument true.
  5. Assert: rawStrings is a List of Strings.
  6. Let cookedStrings be the TemplateStrings of templateLiteral with argument false.
  7. Let count be the number of elements in the List cookedStrings.
  8. Assert: count ≤ 232 - 1.
  9. Let template be ! ArrayCreate(count).
  10. Let rawObj be ! ArrayCreate(count).
  11. Let index be 0.
  12. Repeat, while index < count,
    1. Let prop be ! ToString(𝔽(index)).
    2. Let cookedValue be cookedStrings[index].
    3. Perform ! DefinePropertyOrThrow(template, prop, PropertyDescriptor { [[Value]]: cookedValue, [[Writable]]: false, [[Enumerable]]: true, [[Configurable]]: false }).
    4. Let rawValue be the String value rawStrings[index].
    5. Perform ! DefinePropertyOrThrow(rawObj, prop, PropertyDescriptor { [[Value]]: rawValue, [[Writable]]: false, [[Enumerable]]: true, [[Configurable]]: false }).
    6. Set index to index + 1.
  13. Perform ! SetIntegrityLevel(rawObj, frozen).
  14. Perform ! DefinePropertyOrThrow(template, "raw", PropertyDescriptor { [[Value]]: rawObj, [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: false }).
  15. Perform ! SetIntegrityLevel(template, frozen).
  16. Append the Record { [[Site]]: templateLiteral, [[Array]]: template } to realm.[[TemplateMap]].
  17. Return template.
Note 1

The creation of a template object cannot result in an abrupt completion.

Note 2

Each TemplateLiteral in the program code of a realm is associated with a unique template object that is used in the evaluation of tagged Templates (13.2.8.6). The template objects are frozen and the same template object is used each time a specific tagged Template is evaluated. Whether template objects are created lazily upon first evaluation of the TemplateLiteral or eagerly prior to first evaluation is an implementation choice that is not observable to ECMAScript code.

Note 3

Future editions of this specification may define additional non-enumerable properties of template objects.

13.2.8.5 Runtime Semantics: SubstitutionEvaluation

The syntax-directed operation SubstitutionEvaluation takes no arguments and returns either a normal completion containing a List of ECMAScript language values or an abrupt completion. It is defined piecewise over the following productions:

TemplateSpans : TemplateTail
  1. Return a new empty List.
TemplateSpans : TemplateMiddleList TemplateTail
  1. Return ? SubstitutionEvaluation of TemplateMiddleList.
TemplateMiddleList : TemplateMiddle Expression
  1. Let subRef be ? Evaluation of Expression.
  2. Let sub be ? GetValue(subRef).
  3. Return « sub ».
TemplateMiddleList : TemplateMiddleList TemplateMiddle Expression
  1. Let preceding be ? SubstitutionEvaluation of TemplateMiddleList.
  2. Let nextRef be ? Evaluation of Expression.
  3. Let next be ? GetValue(nextRef).
  4. Return the list-concatenation of preceding and « next ».

13.2.8.6 Runtime Semantics: Evaluation

TemplateLiteral : NoSubstitutionTemplate
  1. Return the TV of NoSubstitutionTemplate as defined in 12.9.6.
SubstitutionTemplate : TemplateHead Expression TemplateSpans
  1. Let head be the TV of TemplateHead as defined in 12.9.6.
  2. Let subRef be ? Evaluation of Expression.
  3. Let sub be ? GetValue(subRef).
  4. Let middle be ? ToString(sub).
  5. Let tail be ? Evaluation of TemplateSpans.
  6. Return the string-concatenation of head, middle, and tail.
Note 1

The string conversion semantics applied to the Expression value are like String.prototype.concat rather than the + operator.

TemplateSpans : TemplateTail
  1. Return the TV of TemplateTail as defined in 12.9.6.
TemplateSpans : TemplateMiddleList TemplateTail
  1. Let head be ? Evaluation of TemplateMiddleList.
  2. Let tail be the TV of TemplateTail as defined in 12.9.6.
  3. Return the string-concatenation of head and tail.
TemplateMiddleList : TemplateMiddle Expression
  1. Let head be the TV of TemplateMiddle as defined in 12.9.6.
  2. Let subRef be ? Evaluation of Expression.
  3. Let sub be ? GetValue(subRef).
  4. Let middle be ? ToString(sub).
  5. Return the string-concatenation of head and middle.
Note 2

The string conversion semantics applied to the Expression value are like String.prototype.concat rather than the + operator.

TemplateMiddleList : TemplateMiddleList TemplateMiddle Expression
  1. Let rest be ? Evaluation of TemplateMiddleList.
  2. Let middle be the TV of TemplateMiddle as defined in 12.9.6.
  3. Let subRef be ? Evaluation of Expression.
  4. Let sub be ? GetValue(subRef).
  5. Let last be ? ToString(sub).
  6. Return the string-concatenation of rest, middle, and last.
Note 3

The string conversion semantics applied to the Expression value are like String.prototype.concat rather than the + operator.

13.2.9 The Grouping Operator

13.2.9.1 Static Semantics: Early Errors

PrimaryExpression : CoverParenthesizedExpressionAndArrowParameterList

13.2.9.2 Runtime Semantics: Evaluation

PrimaryExpression : CoverParenthesizedExpressionAndArrowParameterList
  1. Let expr be the ParenthesizedExpression that is covered by CoverParenthesizedExpressionAndArrowParameterList.
  2. Return ? Evaluation of expr.
ParenthesizedExpression : ( Expression )
  1. Return ? Evaluation of Expression. This may be of type Reference.
Note

This algorithm does not apply GetValue to Evaluation of Expression. The principal motivation for this is so that operators such as delete and typeof may be applied to parenthesized expressions.

13.3 Left-Hand-Side Expressions

Syntax

MemberExpression[Yield, Await] : PrimaryExpression[?Yield, ?Await] MemberExpression[?Yield, ?Await] [ Expression[+In, ?Yield, ?Await] ] MemberExpression[?Yield, ?Await] . IdentifierName MemberExpression[?Yield, ?Await] TemplateLiteral[?Yield, ?Await, +Tagged] SuperProperty[?Yield, ?Await] MetaProperty new MemberExpression[?Yield, ?Await] Arguments[?Yield, ?Await] MemberExpression[?Yield, ?Await] . PrivateIdentifier SuperProperty[Yield, Await] : super [ Expression[+In, ?Yield, ?Await] ] super . IdentifierName MetaProperty : NewTarget ImportMeta NewTarget : new . target ImportMeta : import . meta NewExpression[Yield, Await] : MemberExpression[?Yield, ?Await] new NewExpression[?Yield, ?Await] CallExpression[Yield, Await] : CoverCallExpressionAndAsyncArrowHead[?Yield, ?Await] SuperCall[?Yield, ?Await] ImportCall[?Yield, ?Await] CallExpression[?Yield, ?Await] Arguments[?Yield, ?Await] CallExpression[?Yield, ?Await] [ Expression[+In, ?Yield, ?Await] ] CallExpression[?Yield, ?Await] . IdentifierName CallExpression[?Yield, ?Await] TemplateLiteral[?Yield, ?Await, +Tagged] CallExpression[?Yield, ?Await] . PrivateIdentifier SuperCall[Yield, Await] : super Arguments[?Yield, ?Await] ImportCall[Yield, Await] : import ( AssignmentExpression[+In, ?Yield, ?Await] ,opt ) import ( AssignmentExpression[+In, ?Yield, ?Await] , AssignmentExpression[+In, ?Yield, ?Await] ,opt ) Arguments[Yield, Await] : ( ) ( ArgumentList[?Yield, ?Await] ) ( ArgumentList[?Yield, ?Await] , ) ArgumentList[Yield, Await] : AssignmentExpression[+In, ?Yield, ?Await] ... AssignmentExpression[+In, ?Yield, ?Await] ArgumentList[?Yield, ?Await] , AssignmentExpression[+In, ?Yield, ?Await] ArgumentList[?Yield, ?Await] , ... AssignmentExpression[+In, ?Yield, ?Await] OptionalExpression[Yield, Await] : MemberExpression[?Yield, ?Await] OptionalChain[?Yield, ?Await] CallExpression[?Yield, ?Await] OptionalChain[?Yield, ?Await] OptionalExpression[?Yield, ?Await] OptionalChain[?Yield, ?Await] OptionalChain[Yield, Await] : ?. Arguments[?Yield, ?Await] ?. [ Expression[+In, ?Yield, ?Await] ] ?. IdentifierName ?. TemplateLiteral[?Yield, ?Await, +Tagged] ?. PrivateIdentifier OptionalChain[?Yield, ?Await] Arguments[?Yield, ?Await] OptionalChain[?Yield, ?Await] [ Expression[+In, ?Yield, ?Await] ] OptionalChain[?Yield, ?Await] . IdentifierName OptionalChain[?Yield, ?Await] TemplateLiteral[?Yield, ?Await, +Tagged] OptionalChain[?Yield, ?Await] . PrivateIdentifier LeftHandSideExpression[Yield, Await] : NewExpression[?Yield, ?Await] CallExpression[?Yield, ?Await] OptionalExpression[?Yield, ?Await]

Supplemental Syntax

When processing an instance of the production
CallExpression : CoverCallExpressionAndAsyncArrowHead
the interpretation of CoverCallExpressionAndAsyncArrowHead is refined using the following grammar:

CallMemberExpression[Yield, Await] : MemberExpression[?Yield, ?Await] Arguments[?Yield, ?Await]

13.3.1 Static Semantics

13.3.1.1 Static Semantics: Early Errors

OptionalChain : ?. TemplateLiteral OptionalChain TemplateLiteral
  • It is a Syntax Error if any source text is matched by this production.
Note

This production exists in order to prevent automatic semicolon insertion rules (12.10) from being applied to the following code:

a?.b
`c`

so that it would be interpreted as two valid statements. The purpose is to maintain consistency with similar code without optional chaining:

a.b
`c`

which is a valid statement and where automatic semicolon insertion does not apply.

ImportMeta : import . meta

13.3.2 Property Accessors

Note

Properties are accessed by name, using either the dot notation:

or the bracket notation:

The dot notation is explained by the following syntactic conversion:

is identical in its behaviour to

MemberExpression [ <identifier-name-string> ]

and similarly

is identical in its behaviour to

CallExpression [ <identifier-name-string> ]

where <identifier-name-string> is the StringValue of IdentifierName.

13.3.2.1 Runtime Semantics: Evaluation

MemberExpression : MemberExpression [ Expression ]
  1. Let baseReference be ? Evaluation of MemberExpression.
  2. Let baseValue be ? GetValue(baseReference).
  3. Let strict be IsStrict(this MemberExpression).
  4. Return ? EvaluatePropertyAccessWithExpressionKey(baseValue, Expression, strict).
MemberExpression : MemberExpression . IdentifierName
  1. Let baseReference be ? Evaluation of MemberExpression.
  2. Let baseValue be ? GetValue(baseReference).
  3. Let strict be IsStrict(this MemberExpression).
  4. Return EvaluatePropertyAccessWithIdentifierKey(baseValue, IdentifierName, strict).
MemberExpression : MemberExpression . PrivateIdentifier
  1. Let baseReference be ? Evaluation of MemberExpression.
  2. Let baseValue be ? GetValue(baseReference).
  3. Let fieldNameString be the StringValue of PrivateIdentifier.
  4. Return MakePrivateReference(baseValue, fieldNameString).
CallExpression : CallExpression [ Expression ]
  1. Let baseReference be ? Evaluation of CallExpression.
  2. Let baseValue be ? GetValue(baseReference).
  3. Let strict be IsStrict(this CallExpression).
  4. Return ? EvaluatePropertyAccessWithExpressionKey(baseValue, Expression, strict).
CallExpression : CallExpression . IdentifierName
  1. Let baseReference be ? Evaluation of CallExpression.
  2. Let baseValue be ? GetValue(baseReference).
  3. Let strict be IsStrict(this CallExpression).
  4. Return EvaluatePropertyAccessWithIdentifierKey(baseValue, IdentifierName, strict).
CallExpression : CallExpression . PrivateIdentifier
  1. Let baseReference be ? Evaluation of CallExpression.
  2. Let baseValue be ? GetValue(baseReference).
  3. Let fieldNameString be the StringValue of PrivateIdentifier.
  4. Return MakePrivateReference(baseValue, fieldNameString).

13.3.3 EvaluatePropertyAccessWithExpressionKey ( baseValue, expression, strict )

The abstract operation EvaluatePropertyAccessWithExpressionKey takes arguments baseValue (an ECMAScript language value), expression (an Expression Parse Node), and strict (a Boolean) and returns either a normal completion containing a Reference Record or an abrupt completion. It performs the following steps when called:

  1. Let propertyNameReference be ? Evaluation of expression.
  2. Let propertyNameValue be ? GetValue(propertyNameReference).
  3. NOTE: In most cases, ToPropertyKey will be performed on propertyNameValue immediately after this step. However, in the case of a[b] = c, it will not be performed until after evaluation of c.
  4. Return the Reference Record { [[Base]]: baseValue, [[ReferencedName]]: propertyNameValue, [[Strict]]: strict, [[ThisValue]]: empty }.

13.3.4 EvaluatePropertyAccessWithIdentifierKey ( baseValue, identifierName, strict )

The abstract operation EvaluatePropertyAccessWithIdentifierKey takes arguments baseValue (an ECMAScript language value), identifierName (an IdentifierName Parse Node), and strict (a Boolean) and returns a Reference Record. It performs the following steps when called:

  1. Let propertyNameString be the StringValue of identifierName.
  2. Return the Reference Record { [[Base]]: baseValue, [[ReferencedName]]: propertyNameString, [[Strict]]: strict, [[ThisValue]]: empty }.

13.3.5 The new Operator

13.3.5.1 Runtime Semantics: Evaluation

NewExpression : new NewExpression
  1. Return ? EvaluateNew(NewExpression, empty).
MemberExpression : new MemberExpression Arguments
  1. Return ? EvaluateNew(MemberExpression, Arguments).

13.3.5.1.1 EvaluateNew ( constructExpr, arguments )

The abstract operation EvaluateNew takes arguments constructExpr (a NewExpression Parse Node or a MemberExpression Parse Node) and arguments (empty or an Arguments Parse Node) and returns either a normal completion containing an ECMAScript language value or an abrupt completion. It performs the following steps when called:

  1. Let ref be ? Evaluation of constructExpr.
  2. Let constructor be ? GetValue(ref).
  3. If arguments is empty, then
    1. Let argList be a new empty List.
  4. Else,
    1. Let argList be ? ArgumentListEvaluation of arguments.
  5. If IsConstructor(constructor) is false, throw a TypeError exception.
  6. Return ? Construct(constructor, argList).

13.3.6 Function Calls

13.3.6.1 Runtime Semantics: Evaluation

CallExpression : CoverCallExpressionAndAsyncArrowHead
  1. Let expr be the CallMemberExpression that is covered by CoverCallExpressionAndAsyncArrowHead.
  2. Let memberExpr be the MemberExpression of expr.
  3. Let arguments be the Arguments of expr.
  4. Let ref be ? Evaluation of memberExpr.
  5. Let func be ? GetValue(ref).
  6. If ref is a Reference Record, IsPropertyReference(ref) is false, and ref.[[ReferencedName]] is "eval", then
    1. If SameValue(func, %eval%) is true, then
      1. Let argList be ? ArgumentListEvaluation of arguments.
      2. If argList has no elements, return undefined.
      3. Let evalArg be the first element of argList.
      4. If IsStrict(this CallExpression) is true, let strictCaller be true; otherwise let strictCaller be false.
      5. Return ? PerformEval(evalArg, strictCaller, true).
  7. Let thisCall be this CallExpression.
  8. Let tailCall be IsInTailPosition(thisCall).
  9. Return ? EvaluateCall(func, ref, arguments, tailCall).

A CallExpression evaluation that executes step 6.a.v is a direct eval.

CallExpression : CallExpression Arguments
  1. Let ref be ? Evaluation of CallExpression.
  2. Let func be ? GetValue(ref).
  3. Let thisCall be this CallExpression.
  4. Let tailCall be IsInTailPosition(thisCall).
  5. Return ? EvaluateCall(func, ref, Arguments, tailCall).

13.3.6.2 EvaluateCall ( func, ref, arguments, tailPosition )

The abstract operation EvaluateCall takes arguments func (an ECMAScript language value), ref (an ECMAScript language value or a Reference Record), arguments (a Parse Node), and tailPosition (a Boolean) and returns either a normal completion containing an ECMAScript language value or an abrupt completion. It performs the following steps when called:

  1. If ref is a Reference Record, then
    1. If IsPropertyReference(ref) is true, then
      1. Let thisValue be GetThisValue(ref).
    2. Else,
      1. Let refEnv be ref.[[Base]].
      2. Assert: refEnv is an Environment Record.
      3. Let thisValue be refEnv.WithBaseObject().
  2. Else,
    1. Let thisValue be undefined.
  3. Let argList be ? ArgumentListEvaluation of arguments.
  4. If func is not an Object, throw a TypeError exception.
  5. If IsCallable(func) is false, throw a TypeError exception.
  6. If tailPosition is true, perform PrepareForTailCall().
  7. Return ? Call(func, thisValue, argList).

13.3.7 The super Keyword

13.3.7.1 Runtime Semantics: Evaluation

SuperProperty : super [ Expression ]
  1. Let env be GetThisEnvironment().
  2. Let actualThis be ? env.GetThisBinding().
  3. Let propertyNameReference be ? Evaluation of Expression.
  4. Let propertyNameValue be ? GetValue(propertyNameReference).
  5. Let strict be IsStrict(this SuperProperty).
  6. NOTE: In most cases, ToPropertyKey will be performed on propertyNameValue immediately after this step. However, in the case of super[b] = c, it will not be performed until after evaluation of c.
  7. Return MakeSuperPropertyReference(actualThis, propertyNameValue, strict).
SuperProperty : super . IdentifierName
  1. Let env be GetThisEnvironment().
  2. Let actualThis be ? env.GetThisBinding().
  3. Let propertyKey be the StringValue of IdentifierName.
  4. Let strict be IsStrict(this SuperProperty).
  5. Return MakeSuperPropertyReference(actualThis, propertyKey, strict).
SuperCall : super Arguments
  1. Let newTarget be GetNewTarget().
  2. Assert: newTarget is a constructor.
  3. Let func be GetSuperConstructor().
  4. Let argList be ? ArgumentListEvaluation of Arguments.
  5. If IsConstructor(func) is false, throw a TypeError exception.
  6. Let result be ? Construct(func, argList, newTarget).
  7. Let thisER be GetThisEnvironment().
  8. Assert: thisER is a Function Environment Record.
  9. Perform ? BindThisValue(thisER, result).
  10. Let F be thisER.[[FunctionObject]].
  11. Assert: F is an ECMAScript function object.
  12. Perform ? InitializeInstanceElements(result, F).
  13. Return result.

13.3.7.2 GetSuperConstructor ( )

The abstract operation GetSuperConstructor takes no arguments and returns an ECMAScript language value. It performs the following steps when called:

  1. Let envRec be GetThisEnvironment().
  2. Assert: envRec is a Function Environment Record.
  3. Let activeFunction be envRec.[[FunctionObject]].
  4. Assert: activeFunction is an ECMAScript function object.
  5. Let superConstructor be ! activeFunction.[[GetPrototypeOf]]().
  6. Return superConstructor.

13.3.7.3 MakeSuperPropertyReference ( actualThis, propertyKey, strict )

The abstract operation MakeSuperPropertyReference takes arguments actualThis (an ECMAScript language value), propertyKey (an ECMAScript language value), and strict (a Boolean) and returns a Super Reference Record. It performs the following steps when called:

  1. Let env be GetThisEnvironment().
  2. Assert: env.HasSuperBinding() is true.
  3. Assert: env is a Function Environment Record.
  4. Let baseValue be GetSuperBase(env).
  5. Return the Reference Record { [[Base]]: baseValue, [[ReferencedName]]: propertyKey, [[Strict]]: strict, [[ThisValue]]: actualThis }.

13.3.8 Argument Lists

Note

The evaluation of an argument list produces a List of values.

13.3.8.1 Runtime Semantics: ArgumentListEvaluation

The syntax-directed operation ArgumentListEvaluation takes no arguments and returns either a normal completion containing a List of ECMAScript language values or an abrupt completion. It is defined piecewise over the following productions:

Arguments : ( )
  1. Return a new empty List.
ArgumentList : AssignmentExpression
  1. Let ref be ? Evaluation of AssignmentExpression.
  2. Let arg be ? GetValue(ref).
  3. Return « arg ».
ArgumentList : ... AssignmentExpression
  1. Let list be a new empty List.
  2. Let spreadRef be ? Evaluation of AssignmentExpression.
  3. Let spreadObj be ? GetValue(spreadRef).
  4. Let iteratorRecord be ? GetIterator(spreadObj, sync).
  5. Repeat,
    1. Let next be ? IteratorStepValue(iteratorRecord).
    2. If next is done, return list.
    3. Append next to list.
ArgumentList : ArgumentList , AssignmentExpression
  1. Let precedingArgs be ? ArgumentListEvaluation of ArgumentList.
  2. Let ref be ? Evaluation of AssignmentExpression.
  3. Let arg be ? GetValue(ref).
  4. Return the list-concatenation of precedingArgs and « arg ».
ArgumentList : ArgumentList , ... AssignmentExpression
  1. Let precedingArgs be ? ArgumentListEvaluation of ArgumentList.
  2. Let spreadRef be ? Evaluation of AssignmentExpression.
  3. Let iteratorRecord be ? GetIterator(? GetValue(spreadRef), sync).
  4. Repeat,
    1. Let next be ? IteratorStepValue(iteratorRecord).
    2. If next is done, return precedingArgs.
    3. Append next to precedingArgs.
TemplateLiteral : NoSubstitutionTemplate
  1. Let templateLiteral be this TemplateLiteral.
  2. Let siteObj be GetTemplateObject(templateLiteral).
  3. Return « siteObj ».
TemplateLiteral : SubstitutionTemplate
  1. Let templateLiteral be this TemplateLiteral.
  2. Let siteObj be GetTemplateObject(templateLiteral).
  3. Let remaining be ? ArgumentListEvaluation of SubstitutionTemplate.
  4. Return the list-concatenation of « siteObj » and remaining.
SubstitutionTemplate : TemplateHead Expression TemplateSpans
  1. Let firstSubRef be ? Evaluation of Expression.
  2. Let firstSub be ? GetValue(firstSubRef).
  3. Let restSub be ? SubstitutionEvaluation of TemplateSpans.
  4. Assert: restSub is a possibly empty List.
  5. Return the list-concatenation of « firstSub » and restSub.

13.3.9 Optional Chains

Note
An optional chain is a chain of one or more property accesses and function calls, the first of which begins with the token ?..

13.3.9.1 Runtime Semantics: Evaluation

OptionalExpression : MemberExpression OptionalChain
  1. Let baseReference be ? Evaluation of MemberExpression.
  2. Let baseValue be ? GetValue(baseReference).
  3. If baseValue is either undefined or null, then
    1. Return undefined.
  4. Return ? ChainEvaluation of OptionalChain with arguments baseValue and baseReference.
OptionalExpression : CallExpression OptionalChain
  1. Let baseReference be ? Evaluation of CallExpression.
  2. Let baseValue be ? GetValue(baseReference).
  3. If baseValue is either undefined or null, then
    1. Return undefined.
  4. Return ? ChainEvaluation of OptionalChain with arguments baseValue and baseReference.
OptionalExpression : OptionalExpression OptionalChain
  1. Let baseReference be ? Evaluation of OptionalExpression.
  2. Let baseValue be ? GetValue(baseReference).
  3. If baseValue is either undefined or null, then
    1. Return undefined.
  4. Return ? ChainEvaluation of OptionalChain with arguments baseValue and baseReference.

13.3.9.2 Runtime Semantics: ChainEvaluation

The syntax-directed operation ChainEvaluation takes arguments baseValue (an ECMAScript language value) and baseReference (an ECMAScript language value or a Reference Record) and returns either a normal completion containing either an ECMAScript language value or a Reference Record, or an abrupt completion. It is defined piecewise over the following productions:

OptionalChain : ?. Arguments
  1. Let thisChain be this OptionalChain.
  2. Let tailCall be IsInTailPosition(thisChain).
  3. Return ? EvaluateCall(baseValue, baseReference, Arguments, tailCall).
OptionalChain : ?. [ Expression ]
  1. Let strict be IsStrict(this OptionalChain).
  2. Return ? EvaluatePropertyAccessWithExpressionKey(baseValue, Expression, strict).
OptionalChain : ?. IdentifierName
  1. Let strict be IsStrict(this OptionalChain).
  2. Return EvaluatePropertyAccessWithIdentifierKey(baseValue, IdentifierName, strict).
OptionalChain : ?. PrivateIdentifier
  1. Let fieldNameString be the StringValue of PrivateIdentifier.
  2. Return MakePrivateReference(baseValue, fieldNameString).
OptionalChain : OptionalChain Arguments
  1. Let optionalChain be OptionalChain.
  2. Let newReference be ? ChainEvaluation of optionalChain with arguments baseValue and baseReference.
  3. Let newValue be ? GetValue(newReference).
  4. Let thisChain be this OptionalChain.
  5. Let tailCall be IsInTailPosition(thisChain).
  6. Return ? EvaluateCall(newValue, newReference, Arguments, tailCall).
OptionalChain : OptionalChain [ Expression ]
  1. Let optionalChain be OptionalChain.
  2. Let newReference be ? ChainEvaluation of optionalChain with arguments baseValue and baseReference.
  3. Let newValue be ? GetValue(newReference).
  4. Let strict be IsStrict(this OptionalChain).
  5. Return ? EvaluatePropertyAccessWithExpressionKey(newValue, Expression, strict).
OptionalChain : OptionalChain . IdentifierName
  1. Let optionalChain be OptionalChain.
  2. Let newReference be ? ChainEvaluation of optionalChain with arguments baseValue and baseReference.
  3. Let newValue be ? GetValue(newReference).
  4. Let strict be IsStrict(this OptionalChain).
  5. Return EvaluatePropertyAccessWithIdentifierKey(newValue, IdentifierName, strict).
OptionalChain : OptionalChain . PrivateIdentifier
  1. Let optionalChain be OptionalChain.
  2. Let newReference be ? ChainEvaluation of optionalChain with arguments baseValue and baseReference.
  3. Let newValue be ? GetValue(newReference).
  4. Let fieldNameString be the StringValue of PrivateIdentifier.
  5. Return MakePrivateReference(newValue, fieldNameString).

13.3.10 Import Calls

13.3.10.1 Runtime Semantics: Evaluation

ImportCall : import ( AssignmentExpression ,opt )
  1. Return ? EvaluateImportCall(AssignmentExpression).
ImportCall : import ( AssignmentExpression , AssignmentExpression ,opt )
  1. Return ? EvaluateImportCall(the first AssignmentExpression, the second AssignmentExpression).

13.3.10.2 EvaluateImportCall ( specifierExpression [ , optionsExpression ] )

The abstract operation EvaluateImportCall takes argument specifierExpression (a Parse Node) and optional argument optionsExpression (a Parse Node) and returns either a normal completion containing a Promise or an abrupt completion. It performs the following steps when called:

  1. Let referrer be GetActiveScriptOrModule().
  2. If referrer is null, set referrer to the current Realm Record.
  3. Let specifierRef be ? Evaluation of specifierExpression.
  4. Let specifier be ? GetValue(specifierRef).
  5. If optionsExpression is present, then
    1. Let optionsRef be ? Evaluation of optionsExpression.
    2. Let options be ? GetValue(optionsRef).
  6. Else,
    1. Let options be undefined.
  7. Let promiseCapability be ! NewPromiseCapability(%Promise%).
  8. Let specifierString be Completion(ToString(specifier)).
  9. IfAbruptRejectPromise(specifierString, promiseCapability).
  10. Let attributes be a new empty List.
  11. If options is not undefined, then
    1. If options is not an Object, then
      1. Perform ! Call(promiseCapability.[[Reject]], undefined, « a newly created TypeError object »).
      2. Return promiseCapability.[[Promise]].
    2. Let attributesObj be Completion(Get(options, "with")).
    3. IfAbruptRejectPromise(attributesObj, promiseCapability).
    4. If attributesObj is not undefined, then
      1. If attributesObj is not an Object, then
        1. Perform ! Call(promiseCapability.[[Reject]], undefined, « a newly created TypeError object »).
        2. Return promiseCapability.[[Promise]].
      2. Let entries be Completion(EnumerableOwnProperties(attributesObj, key+value)).
      3. IfAbruptRejectPromise(entries, promiseCapability).
      4. For each element entry of entries, do
        1. Let key be ! Get(entry, "0").
        2. Let value be ! Get(entry, "1").
        3. If key is a String, then
          1. If value is not a String, then
            1. Perform ! Call(promiseCapability.[[Reject]], undefined, « a newly created TypeError object »).
            2. Return promiseCapability.[[Promise]].
          2. Append the ImportAttribute Record { [[Key]]: key, [[Value]]: value } to attributes.
    5. If AllImportAttributesSupported(attributes) is false, then
      1. Perform ! Call(promiseCapability.[[Reject]], undefined, « a newly created TypeError object »).
      2. Return promiseCapability.[[Promise]].
    6. Sort attributes according to the lexicographic order of their [[Key]] field, treating the value of each such field as a sequence of UTF-16 code unit values. NOTE: This sorting is observable only in that hosts are prohibited from changing behaviour based on the order in which attributes are enumerated.
  12. Let moduleRequest be a new ModuleRequest Record { [[Specifier]]: specifierString, [[Attributes]]: attributes }.
  13. Perform HostLoadImportedModule(referrer, moduleRequest, empty, promiseCapability).
  14. Return promiseCapability.[[Promise]].

13.3.10.3 ContinueDynamicImport ( promiseCapability, moduleCompletion )

The abstract operation ContinueDynamicImport takes arguments promiseCapability (a PromiseCapability Record) and moduleCompletion (either a normal completion containing a Module Record or a throw completion) and returns unused. It completes the process of a dynamic import originally started by an import() call, resolving or rejecting the promise returned by that call as appropriate. It performs the following steps when called:

  1. If moduleCompletion is an abrupt completion, then
    1. Perform ! Call(promiseCapability.[[Reject]], undefined, « moduleCompletion.[[Value]] »).
    2. Return unused.
  2. Let module be moduleCompletion.[[Value]].
  3. Let loadPromise be module.LoadRequestedModules().
  4. Let rejectedClosure be a new Abstract Closure with parameters (reason) that captures promiseCapability and performs the following steps when called:
    1. Perform ! Call(promiseCapability.[[Reject]], undefined, « reason »).
    2. Return NormalCompletion(undefined).
  5. Let onRejected be CreateBuiltinFunction(rejectedClosure, 1, "", « »).
  6. Let linkAndEvaluateClosure be a new Abstract Closure with no parameters that captures module, promiseCapability, and onRejected and performs the following steps when called:
    1. Let link be Completion(module.Link()).
    2. If link is an abrupt completion, then
      1. Perform ! Call(promiseCapability.[[Reject]], undefined, « link.[[Value]] »).
      2. Return NormalCompletion(undefined).
    3. Let evaluatePromise be module.Evaluate().
    4. Let fulfilledClosure be a new Abstract Closure with no parameters that captures module and promiseCapability and performs the following steps when called:
      1. Let namespace be GetModuleNamespace(module).
      2. Perform ! Call(promiseCapability.[[Resolve]], undefined, « namespace »).
      3. Return NormalCompletion(undefined).
    5. Let onFulfilled be CreateBuiltinFunction(fulfilledClosure, 0, "", « »).
    6. Perform PerformPromiseThen(evaluatePromise, onFulfilled, onRejected).
    7. Return unused.
  7. Let linkAndEvaluate be CreateBuiltinFunction(linkAndEvaluateClosure, 0, "", « »).
  8. Perform PerformPromiseThen(loadPromise, linkAndEvaluate, onRejected).
  9. Return unused.

13.3.11 Tagged Templates

Note

A tagged template is a function call where the arguments of the call are derived from a TemplateLiteral (13.2.8). The actual arguments include a template object (13.2.8.4) and the values produced by evaluating the expressions embedded within the TemplateLiteral.

13.3.11.1 Runtime Semantics: Evaluation

MemberExpression : MemberExpression TemplateLiteral
  1. Let tagRef be ? Evaluation of MemberExpression.
  2. Let tagFunc be ? GetValue(tagRef).
  3. Let thisCall be this MemberExpression.
  4. Let tailCall be IsInTailPosition(thisCall).
  5. Return ? EvaluateCall(tagFunc, tagRef, TemplateLiteral, tailCall).
CallExpression : CallExpression TemplateLiteral
  1. Let tagRef be ? Evaluation of CallExpression.
  2. Let tagFunc be ? GetValue(tagRef).
  3. Let thisCall be this CallExpression.
  4. Let tailCall be IsInTailPosition(thisCall).
  5. Return ? EvaluateCall(tagFunc, tagRef, TemplateLiteral, tailCall).

13.3.12 Meta Properties

13.3.12.1 Runtime Semantics: Evaluation

NewTarget : new . target
  1. Return GetNewTarget().
ImportMeta : import . meta
  1. Let module be GetActiveScriptOrModule().
  2. Assert: module is a Source Text Module Record.
  3. Let importMeta be module.[[ImportMeta]].
  4. If importMeta is empty, then
    1. Set importMeta to OrdinaryObjectCreate(null).
    2. Let importMetaValues be HostGetImportMetaProperties(module).
    3. For each Record { [[Key]], [[Value]] } p of importMetaValues, do
      1. Perform ! CreateDataPropertyOrThrow(importMeta, p.[[Key]], p.[[Value]]).
    4. Perform HostFinalizeImportMeta(importMeta, module).
    5. Set module.[[ImportMeta]] to importMeta.
    6. Return importMeta.
  5. Else,
    1. Assert: importMeta is an Object.
    2. Return importMeta.

13.3.12.1.1 HostGetImportMetaProperties ( moduleRecord )

The host-defined abstract operation HostGetImportMetaProperties takes argument moduleRecord (a Module Record) and returns a List of Records with fields [[Key]] (a property key) and [[Value]] (an ECMAScript language value). It allows hosts to provide property keys and values for the object returned from import.meta.

The default implementation of HostGetImportMetaProperties is to return a new empty List.

13.3.12.1.2 HostFinalizeImportMeta ( importMeta, moduleRecord )

The host-defined abstract operation HostFinalizeImportMeta takes arguments importMeta (an Object) and moduleRecord (a Module Record) and returns unused. It allows hosts to perform any extraordinary operations to prepare the object returned from import.meta.

Most hosts will be able to simply define HostGetImportMetaProperties, and leave HostFinalizeImportMeta with its default behaviour. However, HostFinalizeImportMeta provides an "escape hatch" for hosts which need to directly manipulate the object before it is exposed to ECMAScript code.

The default implementation of HostFinalizeImportMeta is to return unused.

13.4 Update Expressions

Syntax

UpdateExpression[Yield, Await] : LeftHandSideExpression[?Yield, ?Await] LeftHandSideExpression[?Yield, ?Await] [no LineTerminator here] ++ LeftHandSideExpression[?Yield, ?Await] [no LineTerminator here] -- ++ UnaryExpression[?Yield, ?Await] -- UnaryExpression[?Yield, ?Await]

13.4.1 Static Semantics: Early Errors

UpdateExpression : LeftHandSideExpression ++ LeftHandSideExpression -- UpdateExpression : ++ UnaryExpression -- UnaryExpression

13.4.2 Postfix Increment Operator

13.4.2.1 Runtime Semantics: Evaluation

UpdateExpression : LeftHandSideExpression ++
  1. Let lhs be ? Evaluation of LeftHandSideExpression.
  2. If the AssignmentTargetType of LeftHandSideExpression is web-compat, throw a ReferenceError exception.
  3. Let oldValue be ? ToNumeric(? GetValue(lhs)).
  4. If oldValue is a Number, then
    1. Let newValue be Number::add(oldValue, 1𝔽).
  5. Else,
    1. Assert: oldValue is a BigInt.
    2. Let newValue be BigInt::add(oldValue, 1).
  6. Perform ? PutValue(lhs, newValue).
  7. Return oldValue.

13.4.3 Postfix Decrement Operator

13.4.3.1 Runtime Semantics: Evaluation

UpdateExpression : LeftHandSideExpression --
  1. Let lhs be ? Evaluation of LeftHandSideExpression.
  2. If the AssignmentTargetType of LeftHandSideExpression is web-compat, throw a ReferenceError exception.
  3. Let oldValue be ? ToNumeric(? GetValue(lhs)).
  4. If oldValue is a Number, then
    1. Let newValue be Number::subtract(oldValue, 1𝔽).
  5. Else,
    1. Assert: oldValue is a BigInt.
    2. Let newValue be BigInt::subtract(oldValue, 1).
  6. Perform ? PutValue(lhs, newValue).
  7. Return oldValue.

13.4.4 Prefix Increment Operator

13.4.4.1 Runtime Semantics: Evaluation

UpdateExpression : ++ UnaryExpression
  1. Let expr be ? Evaluation of UnaryExpression.
  2. If the AssignmentTargetType of UnaryExpression is web-compat, throw a ReferenceError exception.
  3. Let oldValue be ? ToNumeric(? GetValue(expr)).
  4. If oldValue is a Number, then
    1. Let newValue be Number::add(oldValue, 1𝔽).
  5. Else,
    1. Assert: oldValue is a BigInt.
    2. Let newValue be BigInt::add(oldValue, 1).
  6. Perform ? PutValue(expr, newValue).
  7. Return newValue.

13.4.5 Prefix Decrement Operator

13.4.5.1 Runtime Semantics: Evaluation

UpdateExpression : -- UnaryExpression
  1. Let expr be ? Evaluation of UnaryExpression.
  2. If the AssignmentTargetType of UnaryExpression is web-compat, throw a ReferenceError exception.
  3. Let oldValue be ? ToNumeric(? GetValue(expr)).
  4. If oldValue is a Number, then
    1. Let newValue be Number::subtract(oldValue, 1𝔽).
  5. Else,
    1. Assert: oldValue is a BigInt.
    2. Let newValue be BigInt::subtract(oldValue, 1).
  6. Perform ? PutValue(expr, newValue).
  7. Return newValue.

13.5 Unary Operators

Syntax

UnaryExpression[Yield, Await] : UpdateExpression[?Yield, ?Await] delete UnaryExpression[?Yield, ?Await] void UnaryExpression[?Yield, ?Await] typeof UnaryExpression[?Yield, ?Await] + UnaryExpression[?Yield, ?Await] - UnaryExpression[?Yield, ?Await] ~ UnaryExpression[?Yield, ?Await] ! UnaryExpression[?Yield, ?Await] [+Await] AwaitExpression[?Yield]

13.5.1 The delete Operator

13.5.1.1 Static Semantics: Early Errors

UnaryExpression : delete UnaryExpression Note

The last rule means that expressions such as delete (((foo))) produce early errors because of recursive application of the first rule.

13.5.1.2 Runtime Semantics: Evaluation

UnaryExpression : delete UnaryExpression
  1. Let ref be ? Evaluation of UnaryExpression.
  2. If ref is not a Reference Record, return true.
  3. If IsUnresolvableReference(ref) is true, then
    1. Assert: ref.[[Strict]] is false.
    2. Return true.
  4. If IsPropertyReference(ref) is true, then
    1. Assert: IsPrivateReference(ref) is false.
    2. If IsSuperReference(ref) is true, throw a ReferenceError exception.
    3. Let baseObj be ? ToObject(ref.[[Base]]).
    4. If ref.[[ReferencedName]] is not a property key, then
      1. Set ref.[[ReferencedName]] to ? ToPropertyKey(ref.[[ReferencedName]]).
    5. Let deleteStatus be ? baseObj.[[Delete]](ref.[[ReferencedName]]).
    6. If deleteStatus is false and ref.[[Strict]] is true, throw a TypeError exception.
    7. Return deleteStatus.
  5. Else,
    1. Let base be ref.[[Base]].
    2. Assert: base is an Environment Record.
    3. Return ? base.DeleteBinding(ref.[[ReferencedName]]).
Note 1

When a delete operator occurs within strict mode code, a SyntaxError exception is thrown if its UnaryExpression is a direct reference to a variable, function argument, or function name. In addition, if a delete operator occurs within strict mode code and the property to be deleted has the attribute { [[Configurable]]: false } (or otherwise cannot be deleted), a TypeError exception is thrown.

Note 2

The object that may be created in step 4.c is not accessible outside of the above abstract operation and the ordinary object [[Delete]] internal method. An implementation might choose to avoid the actual creation of that object.

13.5.2 The void Operator

13.5.2.1 Runtime Semantics: Evaluation

UnaryExpression : void UnaryExpression
  1. Let expr be ? Evaluation of UnaryExpression.
  2. Perform ? GetValue(expr).
  3. Return undefined.
Note

GetValue must be called even though its value is not used because it may have observable side-effects.

13.5.3 The typeof Operator

13.5.3.1 Runtime Semantics: Evaluation

UnaryExpression : typeof UnaryExpression
  1. Let val be ? Evaluation of UnaryExpression.
  2. If val is a Reference Record, then
    1. If IsUnresolvableReference(val) is true, return "undefined".
  3. Set val to ? GetValue(val).
  4. If val is undefined, return "undefined".
  5. If val is null, return "object".
  6. If val is a String, return "string".
  7. If val is a Symbol, return "symbol".
  8. If val is a Boolean, return "boolean".
  9. If val is a Number, return "number".
  10. If val is a BigInt, return "bigint".
  11. Assert: val is an Object.
  12. NOTE: This step is replaced in section B.3.6.3.
  13. If val has a [[Call]] internal method, return "function".
  14. Return "object".

13.5.4 Unary + Operator

Note

The unary + operator converts its operand to Number type.

13.5.4.1 Runtime Semantics: Evaluation

UnaryExpression : + UnaryExpression
  1. Let expr be ? Evaluation of UnaryExpression.
  2. Return ? ToNumber(? GetValue(expr)).

13.5.5 Unary - Operator

Note

The unary - operator converts its operand to a numeric value and then negates it. Negating +0𝔽 produces -0𝔽, and negating -0𝔽 produces +0𝔽.

13.5.5.1 Runtime Semantics: Evaluation

UnaryExpression : - UnaryExpression
  1. Let expr be ? Evaluation of UnaryExpression.
  2. Let oldValue be ? ToNumeric(? GetValue(expr)).
  3. If oldValue is a Number, then
    1. Return Number::unaryMinus(oldValue).
  4. Else,
    1. Assert: oldValue is a BigInt.
    2. Return BigInt::unaryMinus(oldValue).

13.5.6 Bitwise NOT Operator ( ~ )

13.5.6.1 Runtime Semantics: Evaluation

UnaryExpression : ~ UnaryExpression
  1. Let expr be ? Evaluation of UnaryExpression.
  2. Let oldValue be ? ToNumeric(? GetValue(expr)).
  3. If oldValue is a Number, then
    1. Return Number::bitwiseNOT(oldValue).
  4. Else,
    1. Assert: oldValue is a BigInt.
    2. Return BigInt::bitwiseNOT(oldValue).

13.5.7 Logical NOT Operator ( ! )

13.5.7.1 Runtime Semantics: Evaluation

UnaryExpression : ! UnaryExpression
  1. Let expr be ? Evaluation of UnaryExpression.
  2. Let oldValue be ToBoolean(? GetValue(expr)).
  3. If oldValue is true, return false.
  4. Return true.

13.6 Exponentiation Operator

Syntax

ExponentiationExpression[Yield, Await] : UnaryExpression[?Yield, ?Await] UpdateExpression[?Yield, ?Await] ** ExponentiationExpression[?Yield, ?Await]

13.6.1 Runtime Semantics: Evaluation

ExponentiationExpression : UpdateExpression ** ExponentiationExpression
  1. Return ? EvaluateStringOrNumericBinaryExpression(UpdateExpression, **, ExponentiationExpression).

13.7 Multiplicative Operators

Syntax

MultiplicativeExpression[Yield, Await] : ExponentiationExpression[?Yield, ?Await] MultiplicativeExpression[?Yield, ?Await] MultiplicativeOperator ExponentiationExpression[?Yield, ?Await] MultiplicativeOperator : one of * / % Note
  • The * operator performs multiplication, producing the product of its operands.
  • The / operator performs division, producing the quotient of its operands.
  • The % operator yields the remainder of its operands from an implied division.

13.7.1 Runtime Semantics: Evaluation

MultiplicativeExpression : MultiplicativeExpression MultiplicativeOperator ExponentiationExpression
  1. Let opText be the source text matched by MultiplicativeOperator.
  2. Return ? EvaluateStringOrNumericBinaryExpression(MultiplicativeExpression, opText, ExponentiationExpression).

13.8 Additive Operators

Syntax

AdditiveExpression[Yield, Await] : MultiplicativeExpression[?Yield, ?Await] AdditiveExpression[?Yield, ?Await] + MultiplicativeExpression[?Yield, ?Await] AdditiveExpression[?Yield, ?Await] - MultiplicativeExpression[?Yield, ?Await]

13.8.1 The Addition Operator ( + )

Note

The addition operator either performs string concatenation or numeric addition.

13.8.1.1 Runtime Semantics: Evaluation

AdditiveExpression : AdditiveExpression + MultiplicativeExpression
  1. Return ? EvaluateStringOrNumericBinaryExpression(AdditiveExpression, +, MultiplicativeExpression).

13.8.2 The Subtraction Operator ( - )

Note

The - operator performs subtraction, producing the difference of its operands.

13.8.2.1 Runtime Semantics: Evaluation

AdditiveExpression : AdditiveExpression - MultiplicativeExpression
  1. Return ? EvaluateStringOrNumericBinaryExpression(AdditiveExpression, -, MultiplicativeExpression).

13.9 Bitwise Shift Operators

Syntax

ShiftExpression[Yield, Await] : AdditiveExpression[?Yield, ?Await] ShiftExpression[?Yield, ?Await] << AdditiveExpression[?Yield, ?Await] ShiftExpression[?Yield, ?Await] >> AdditiveExpression[?Yield, ?Await] ShiftExpression[?Yield, ?Await] >>> AdditiveExpression[?Yield, ?Await]

13.9.1 The Left Shift Operator ( << )

Note

Performs a bitwise left shift operation on the left operand by the amount specified by the right operand.

13.9.1.1 Runtime Semantics: Evaluation

ShiftExpression : ShiftExpression << AdditiveExpression
  1. Return ? EvaluateStringOrNumericBinaryExpression(ShiftExpression, <<, AdditiveExpression).

13.9.2 The Signed Right Shift Operator ( >> )

Note

Performs a sign-filling bitwise right shift operation on the left operand by the amount specified by the right operand.

13.9.2.1 Runtime Semantics: Evaluation

ShiftExpression : ShiftExpression >> AdditiveExpression
  1. Return ? EvaluateStringOrNumericBinaryExpression(ShiftExpression, >>, AdditiveExpression).

13.9.3 The Unsigned Right Shift Operator ( >>> )

Note

Performs a zero-filling bitwise right shift operation on the left operand by the amount specified by the right operand.

13.9.3.1 Runtime Semantics: Evaluation

ShiftExpression : ShiftExpression >>> AdditiveExpression
  1. Return ? EvaluateStringOrNumericBinaryExpression(ShiftExpression, >>>, AdditiveExpression).

13.10 Relational Operators

Note 1

The result of evaluating a relational operator is always of type Boolean, reflecting whether the relationship named by the operator holds between its two operands.

Syntax

RelationalExpression[In, Yield, Await] : ShiftExpression[?Yield, ?Await] RelationalExpression[?In, ?Yield, ?Await] < ShiftExpression[?Yield, ?Await] RelationalExpression[?In, ?Yield, ?Await] > ShiftExpression[?Yield, ?Await] RelationalExpression[?In, ?Yield, ?Await] <= ShiftExpression[?Yield, ?Await] RelationalExpression[?In, ?Yield, ?Await] >= ShiftExpression[?Yield, ?Await] RelationalExpression[?In, ?Yield, ?Await] instanceof ShiftExpression[?Yield, ?Await] [+In] RelationalExpression[+In, ?Yield, ?Await] in ShiftExpression[?Yield, ?Await] [+In] PrivateIdentifier in ShiftExpression[?Yield, ?Await] Note 2

The [In] grammar parameter is needed to avoid confusing the in operator in a relational expression with the in operator in a for statement.

13.10.1 Runtime Semantics: Evaluation

RelationalExpression : RelationalExpression < ShiftExpression
  1. Let lRef be ? Evaluation of RelationalExpression.
  2. Let lVal be ? GetValue(lRef).
  3. Let rRef be ? Evaluation of ShiftExpression.
  4. Let rVal be ? GetValue(rRef).
  5. Let r be ? IsLessThan(lVal, rVal, true).
  6. If r is undefined, return false; otherwise return r.
RelationalExpression : RelationalExpression > ShiftExpression
  1. Let lRef be ? Evaluation of RelationalExpression.
  2. Let lVal be ? GetValue(lRef).
  3. Let rRef be ? Evaluation of ShiftExpression.
  4. Let rVal be ? GetValue(rRef).
  5. Let r be ? IsLessThan(rVal, lVal, false).
  6. If r is undefined, return false; otherwise return r.
RelationalExpression : RelationalExpression <= ShiftExpression
  1. Let lRef be ? Evaluation of RelationalExpression.
  2. Let lVal be ? GetValue(lRef).
  3. Let rRef be ? Evaluation of ShiftExpression.
  4. Let rVal be ? GetValue(rRef).
  5. Let r be ? IsLessThan(rVal, lVal, false).
  6. If r is either true or undefined, return false; otherwise return true.
RelationalExpression : RelationalExpression >= ShiftExpression
  1. Let lRef be ? Evaluation of RelationalExpression.
  2. Let lVal be ? GetValue(lRef).
  3. Let rRef be ? Evaluation of ShiftExpression.
  4. Let rVal be ? GetValue(rRef).
  5. Let r be ? IsLessThan(lVal, rVal, true).
  6. If r is either true or undefined, return false; otherwise return true.
RelationalExpression : RelationalExpression instanceof ShiftExpression
  1. Let lRef be ? Evaluation of RelationalExpression.
  2. Let lVal be ? GetValue(lRef).
  3. Let rRef be ? Evaluation of ShiftExpression.
  4. Let rVal be ? GetValue(rRef).
  5. Return ? InstanceofOperator(lVal, rVal).
RelationalExpression : RelationalExpression in ShiftExpression
  1. Let lRef be ? Evaluation of RelationalExpression.
  2. Let lVal be ? GetValue(lRef).
  3. Let rRef be ? Evaluation of ShiftExpression.
  4. Let rVal be ? GetValue(rRef).
  5. If rVal is not an Object, throw a TypeError exception.
  6. Return ? HasProperty(rVal, ? ToPropertyKey(lVal)).
RelationalExpression : PrivateIdentifier in ShiftExpression
  1. Let privateIdentifier be the StringValue of PrivateIdentifier.
  2. Let rRef be ? Evaluation of ShiftExpression.
  3. Let rVal be ? GetValue(rRef).
  4. If rVal is not an Object, throw a TypeError exception.
  5. Let privateEnv be the running execution context's PrivateEnvironment.
  6. Assert: privateEnv is not null.
  7. Let privateName be ResolvePrivateIdentifier(privateEnv, privateIdentifier).
  8. If PrivateElementFind(rVal, privateName) is not empty, return true.
  9. Return false.

13.10.2 InstanceofOperator ( V, target )

The abstract operation InstanceofOperator takes arguments V (an ECMAScript language value) and target (an ECMAScript language value) and returns either a normal completion containing a Boolean or a throw completion. It implements the generic algorithm for determining if V is an instance of target either by consulting target's %Symbol.hasInstance% method or, if absent, determining whether the value of target's "prototype" property is present in V's prototype chain. It performs the following steps when called:

  1. If target is not an Object, throw a TypeError exception.
  2. Let instOfHandler be ? GetMethod(target, %Symbol.hasInstance%).
  3. If instOfHandler is not undefined, then
    1. Return ToBoolean(? Call(instOfHandler, target, « V »)).
  4. If IsCallable(target) is false, throw a TypeError exception.
  5. Return ? OrdinaryHasInstance(target, V).
Note

Steps 4 and 5 provide compatibility with previous editions of ECMAScript that did not use a %Symbol.hasInstance% method to define the instanceof operator semantics. If an object does not define or inherit %Symbol.hasInstance% it uses the default instanceof semantics.

13.11 Equality Operators

Note

The result of evaluating an equality operator is always of type Boolean, reflecting whether the relationship named by the operator holds between its two operands.

Syntax

EqualityExpression[In, Yield, Await] : RelationalExpression[?In, ?Yield, ?Await] EqualityExpression[?In, ?Yield, ?Await] == RelationalExpression[?In, ?Yield, ?Await] EqualityExpression[?In, ?Yield, ?Await] != RelationalExpression[?In, ?Yield, ?Await] EqualityExpression[?In, ?Yield, ?Await] === RelationalExpression[?In, ?Yield, ?Await] EqualityExpression[?In, ?Yield, ?Await] !== RelationalExpression[?In, ?Yield, ?Await]

13.11.1 Runtime Semantics: Evaluation

EqualityExpression : EqualityExpression == RelationalExpression
  1. Let lRef be ? Evaluation of EqualityExpression.
  2. Let lVal be ? GetValue(lRef).
  3. Let rRef be ? Evaluation of RelationalExpression.
  4. Let rVal be ? GetValue(rRef).
  5. Return ? IsLooselyEqual(rVal, lVal).
EqualityExpression : EqualityExpression != RelationalExpression
  1. Let lRef be ? Evaluation of EqualityExpression.
  2. Let lVal be ? GetValue(lRef).
  3. Let rRef be ? Evaluation of RelationalExpression.
  4. Let rVal be ? GetValue(rRef).
  5. Let r be ? IsLooselyEqual(rVal, lVal).
  6. If r is true, return false; otherwise return true.
EqualityExpression : EqualityExpression === RelationalExpression
  1. Let lRef be ? Evaluation of EqualityExpression.
  2. Let lVal be ? GetValue(lRef).
  3. Let rRef be ? Evaluation of RelationalExpression.
  4. Let rVal be ? GetValue(rRef).
  5. Return IsStrictlyEqual(rVal, lVal).
EqualityExpression : EqualityExpression !== RelationalExpression
  1. Let lRef be ? Evaluation of EqualityExpression.
  2. Let lVal be ? GetValue(lRef).
  3. Let rRef be ? Evaluation of RelationalExpression.
  4. Let rVal be ? GetValue(rRef).
  5. Let r be IsStrictlyEqual(rVal, lVal).
  6. If r is true, return false; otherwise return true.
Note 1

Given the above definition of equality:

  • String comparison can be forced by: `${a}` == `${b}`.
  • Numeric comparison can be forced by: +a == +b.
  • Boolean comparison can be forced by: !a == !b.
Note 2

The equality operators maintain the following invariants:

  • A != B is equivalent to !(A == B).
  • A == B is equivalent to B == A, except in the order of evaluation of A and B.
Note 3

The equality operator is not always transitive. For example, there might be two distinct String objects, each representing the same String value; each String object would be considered equal to the String value by the == operator, but the two String objects would not be equal to each other. For example:

  • new String("a") == "a" and "a" == new String("a") are both true.
  • new String("a") == new String("a") is false.
Note 4

Comparison of Strings uses a simple equality test on sequences of code unit values. There is no attempt to use the more complex, semantically oriented definitions of character or string equality and collating order defined in the Unicode specification. Therefore Strings values that are canonically equal according to the Unicode Standard could test as unequal. In effect this algorithm assumes that both Strings are already in normalized form.

13.12 Binary Bitwise Operators

Syntax

BitwiseANDExpression[In, Yield, Await] : EqualityExpression[?In, ?Yield, ?Await] BitwiseANDExpression[?In, ?Yield, ?Await] & EqualityExpression[?In, ?Yield, ?Await] BitwiseXORExpression[In, Yield, Await] : BitwiseANDExpression[?In, ?Yield, ?Await] BitwiseXORExpression[?In, ?Yield, ?Await] ^ BitwiseANDExpression[?In, ?Yield, ?Await] BitwiseORExpression[In, Yield, Await] : BitwiseXORExpression[?In, ?Yield, ?Await] BitwiseORExpression[?In, ?Yield, ?Await] | BitwiseXORExpression[?In, ?Yield, ?Await]

13.12.1 Runtime Semantics: Evaluation

BitwiseANDExpression : BitwiseANDExpression & EqualityExpression
  1. Return ? EvaluateStringOrNumericBinaryExpression(BitwiseANDExpression, &, EqualityExpression).
BitwiseXORExpression : BitwiseXORExpression ^ BitwiseANDExpression
  1. Return ? EvaluateStringOrNumericBinaryExpression(BitwiseXORExpression, ^, BitwiseANDExpression).
BitwiseORExpression : BitwiseORExpression | BitwiseXORExpression
  1. Return ? EvaluateStringOrNumericBinaryExpression(BitwiseORExpression, |, BitwiseXORExpression).

13.13 Binary Logical Operators

Syntax

LogicalANDExpression[In, Yield, Await] : BitwiseORExpression[?In, ?Yield, ?Await] LogicalANDExpression[?In, ?Yield, ?Await] && BitwiseORExpression[?In, ?Yield, ?Await] LogicalORExpression[In, Yield, Await] : LogicalANDExpression[?In, ?Yield, ?Await] LogicalORExpression[?In, ?Yield, ?Await] || LogicalANDExpression[?In, ?Yield, ?Await] CoalesceExpression[In, Yield, Await] : CoalesceExpressionHead[?In, ?Yield, ?Await] ?? BitwiseORExpression[?In, ?Yield, ?Await] CoalesceExpressionHead[In, Yield, Await] : CoalesceExpression[?In, ?Yield, ?Await] BitwiseORExpression[?In, ?Yield, ?Await] ShortCircuitExpression[In, Yield, Await] : LogicalORExpression[?In, ?Yield, ?Await] CoalesceExpression[?In, ?Yield, ?Await] Note

The value produced by a && or || operator is not necessarily of type Boolean. The value produced will always be the value of one of the two operand expressions.

13.13.1 Runtime Semantics: Evaluation

LogicalANDExpression : LogicalANDExpression && BitwiseORExpression
  1. Let lRef be ? Evaluation of LogicalANDExpression.
  2. Let lVal be ? GetValue(lRef).
  3. If ToBoolean(lVal) is false, return lVal.
  4. Let rRef be ? Evaluation of BitwiseORExpression.
  5. Return ? GetValue(rRef).
LogicalORExpression : LogicalORExpression || LogicalANDExpression
  1. Let lRef be ? Evaluation of LogicalORExpression.
  2. Let lVal be ? GetValue(lRef).
  3. If ToBoolean(lVal) is true, return lVal.
  4. Let rRef be ? Evaluation of LogicalANDExpression.
  5. Return ? GetValue(rRef).
CoalesceExpression : CoalesceExpressionHead ?? BitwiseORExpression
  1. Let lRef be ? Evaluation of CoalesceExpressionHead.
  2. Let lVal be ? GetValue(lRef).
  3. If lVal is either undefined or null, then
    1. Let rRef be ? Evaluation of BitwiseORExpression.
    2. Return ? GetValue(rRef).
  4. Else,
    1. Return lVal.

13.14 Conditional Operator ( ? : )

Syntax

ConditionalExpression[In, Yield, Await] : ShortCircuitExpression[?In, ?Yield, ?Await] ShortCircuitExpression[?In, ?Yield, ?Await] ? AssignmentExpression[+In, ?Yield, ?Await] : AssignmentExpression[?In, ?Yield, ?Await] Note

The grammar for a ConditionalExpression in ECMAScript is slightly different from that in C and Java, which each allow the second subexpression to be an Expression but restrict the third expression to be a ConditionalExpression. The motivation for this difference in ECMAScript is to allow an assignment expression to be governed by either arm of a conditional and to eliminate the confusing and fairly useless case of a comma expression as the centre expression.

13.14.1 Runtime Semantics: Evaluation

ConditionalExpression : ShortCircuitExpression ? AssignmentExpression : AssignmentExpression
  1. Let lRef be ? Evaluation of ShortCircuitExpression.
  2. Let lVal be ToBoolean(? GetValue(lRef)).
  3. If lVal is true, then
    1. Let trueRef be ? Evaluation of the first AssignmentExpression.
    2. Return ? GetValue(trueRef).
  4. Else,
    1. Let falseRef be ? Evaluation of the second AssignmentExpression.
    2. Return ? GetValue(falseRef).

13.15 Assignment Operators

Syntax

AssignmentExpression[In, Yield, Await] : ConditionalExpression[?In, ?Yield, ?Await] [+Yield] YieldExpression[?In, ?Await] ArrowFunction[?In, ?Yield, ?Await] AsyncArrowFunction[?In, ?Yield, ?Await] LeftHandSideExpression[?Yield, ?Await] = AssignmentExpression[?In, ?Yield, ?Await] LeftHandSideExpression[?Yield, ?Await] AssignmentOperator AssignmentExpression[?In, ?Yield, ?Await] LeftHandSideExpression[?Yield, ?Await] &&= AssignmentExpression[?In, ?Yield, ?Await] LeftHandSideExpression[?Yield, ?Await] ||= AssignmentExpression[?In, ?Yield, ?Await] LeftHandSideExpression[?Yield, ?Await] ??= AssignmentExpression[?In, ?Yield, ?Await] AssignmentOperator : one of *= /= %= += -= <<= >>= >>>= &= ^= |= **=

13.15.1 Static Semantics: Early Errors

AssignmentExpression : LeftHandSideExpression = AssignmentExpression AssignmentExpression : LeftHandSideExpression AssignmentOperator AssignmentExpression AssignmentExpression : LeftHandSideExpression &&= AssignmentExpression LeftHandSideExpression ||= AssignmentExpression LeftHandSideExpression ??= AssignmentExpression

13.15.2 Runtime Semantics: Evaluation

AssignmentExpression : LeftHandSideExpression = AssignmentExpression
  1. If LeftHandSideExpression is neither an ObjectLiteral nor an ArrayLiteral, then
    1. Let lRef be ? Evaluation of LeftHandSideExpression.
    2. If the AssignmentTargetType of LeftHandSideExpression is web-compat, throw a ReferenceError exception.
    3. If IsAnonymousFunctionDefinition(AssignmentExpression) is true and IsIdentifierRef of LeftHandSideExpression is true, then
      1. Let lhs be the StringValue of LeftHandSideExpression.
      2. Let rVal be ? NamedEvaluation of AssignmentExpression with argument lhs.
    4. Else,
      1. Let rRef be ? Evaluation of AssignmentExpression.
      2. Let rVal be ? GetValue(rRef).
    5. Perform ? PutValue(lRef, rVal).
    6. Return rVal.
  2. Let assignmentPattern be the AssignmentPattern that is covered by LeftHandSideExpression.
  3. Let rRef be ? Evaluation of AssignmentExpression.
  4. Let rVal be ? GetValue(rRef).
  5. Perform ? DestructuringAssignmentEvaluation of assignmentPattern with argument rVal.
  6. Return rVal.
AssignmentExpression : LeftHandSideExpression AssignmentOperator AssignmentExpression
  1. Let lRef be ? Evaluation of LeftHandSideExpression.
  2. If the AssignmentTargetType of LeftHandSideExpression is web-compat, throw a ReferenceError exception.
  3. Let lVal be ? GetValue(lRef).
  4. Let rRef be ? Evaluation of AssignmentExpression.
  5. Let rVal be ? GetValue(rRef).
  6. Let assignmentOpText be the source text matched by AssignmentOperator.
  7. Let opText be the sequence of Unicode code points associated with assignmentOpText in the following table:
    assignmentOpText opText
    **= **
    *= *
    /= /
    %= %
    += +
    -= -
    <<= <<
    >>= >>
    >>>= >>>
    &= &
    ^= ^
    |= |
  8. Let r be ? ApplyStringOrNumericBinaryOperator(lVal, opText, rVal).
  9. Perform ? PutValue(lRef, r).
  10. Return r.
AssignmentExpression : LeftHandSideExpression &&= AssignmentExpression
  1. Let lRef be ? Evaluation of LeftHandSideExpression.
  2. Let lVal be ? GetValue(lRef).
  3. If ToBoolean(lVal) is false, return lVal.
  4. If IsAnonymousFunctionDefinition(AssignmentExpression) is true and IsIdentifierRef of LeftHandSideExpression is true, then
    1. Let lhs be the StringValue of LeftHandSideExpression.
    2. Let rVal be ? NamedEvaluation of AssignmentExpression with argument lhs.
  5. Else,
    1. Let rRef be ? Evaluation of AssignmentExpression.
    2. Let rVal be ? GetValue(rRef).
  6. Perform ? PutValue(lRef, rVal).
  7. Return rVal.
AssignmentExpression : LeftHandSideExpression ||= AssignmentExpression
  1. Let lRef be ? Evaluation of LeftHandSideExpression.
  2. Let lVal be ? GetValue(lRef).
  3. If ToBoolean(lVal) is true, return lVal.
  4. If IsAnonymousFunctionDefinition(AssignmentExpression) is true and IsIdentifierRef of LeftHandSideExpression is true, then
    1. Let lhs be the StringValue of LeftHandSideExpression.
    2. Let rVal be ? NamedEvaluation of AssignmentExpression with argument lhs.
  5. Else,
    1. Let rRef be ? Evaluation of AssignmentExpression.
    2. Let rVal be ? GetValue(rRef).
  6. Perform ? PutValue(lRef, rVal).
  7. Return rVal.
AssignmentExpression : LeftHandSideExpression ??= AssignmentExpression
  1. Let lRef be ? Evaluation of LeftHandSideExpression.
  2. Let lVal be ? GetValue(lRef).
  3. If lVal is neither undefined nor null, return lVal.
  4. If IsAnonymousFunctionDefinition(AssignmentExpression) is true and IsIdentifierRef of LeftHandSideExpression is true, then
    1. Let lhs be the StringValue of LeftHandSideExpression.
    2. Let rVal be ? NamedEvaluation of AssignmentExpression with argument lhs.
  5. Else,
    1. Let rRef be ? Evaluation of AssignmentExpression.
    2. Let rVal be ? GetValue(rRef).
  6. Perform ? PutValue(lRef, rVal).
  7. Return rVal.
Note

When this expression occurs within strict mode code, it is a runtime error if lRef in step 1.e, 3, 2, 2, 2 is an unresolvable reference. If it is, a ReferenceError exception is thrown. Additionally, it is a runtime error if the lRef in step 9, 6, 6, 6 is a reference to a data property with the attribute value { [[Writable]]: false }, to an accessor property with the attribute value { [[Set]]: undefined }, or to a non-existent property of an object for which the IsExtensible predicate returns the value false. In these cases a TypeError exception is thrown.

13.15.3 ApplyStringOrNumericBinaryOperator ( lVal, opText, rVal )

The abstract operation ApplyStringOrNumericBinaryOperator takes arguments lVal (an ECMAScript language value), opText (**, *, /, %, +, -, <<, >>, >>>, &, ^, or |), and rVal (an ECMAScript language value) and returns either a normal completion containing either a String, a BigInt, or a Number, or a throw completion. It performs the following steps when called:

  1. If opText is +, then
    1. Let lPrim be ? ToPrimitive(lVal).
    2. Let rPrim be ? ToPrimitive(rVal).
    3. If lPrim is a String or rPrim is a String, then
      1. Let lStr be ? ToString(lPrim).
      2. Let rStr be ? ToString(rPrim).
      3. Return the string-concatenation of lStr and rStr.
    4. Set lVal to lPrim.
    5. Set rVal to rPrim.
  2. NOTE: At this point, it must be a numeric operation.
  3. Let lNum be ? ToNumeric(lVal).
  4. Let rNum be ? ToNumeric(rVal).
  5. If SameType(lNum, rNum) is false, throw a TypeError exception.
  6. If lNum is a BigInt, then
    1. If opText is **, return ? BigInt::exponentiate(lNum, rNum).
    2. If opText is /, return ? BigInt::divide(lNum, rNum).
    3. If opText is %, return ? BigInt::remainder(lNum, rNum).
    4. If opText is >>>, return ? BigInt::unsignedRightShift(lNum, rNum).
    5. Let operation be the abstract operation associated with opText in the following table:
      opText operation
      * BigInt::multiply
      + BigInt::add
      - BigInt::subtract
      << BigInt::leftShift
      >> BigInt::signedRightShift
      & BigInt::bitwiseAND
      ^ BigInt::bitwiseXOR
      | BigInt::bitwiseOR
  7. Else,
    1. Assert: lNum is a Number.
    2. Let operation be the abstract operation associated with opText in the following table:
      opText operation
      ** Number::exponentiate
      * Number::multiply
      / Number::divide
      % Number::remainder
      + Number::add
      - Number::subtract
      << Number::leftShift
      >> Number::signedRightShift
      >>> Number::unsignedRightShift
      & Number::bitwiseAND
      ^ Number::bitwiseXOR
      | Number::bitwiseOR
  8. Return operation(lNum, rNum).
Note 1

No hint is provided in the calls to ToPrimitive in steps 1.a and 1.b. All standard objects except Dates handle the absence of a hint as if number were given; Dates handle the absence of a hint as if string were given. Exotic objects may handle the absence of a hint in some other manner.

Note 2

Step 1.c differs from step 3 of the IsLessThan algorithm, by using the logical-or operation instead of the logical-and operation.

13.15.4 EvaluateStringOrNumericBinaryExpression ( leftOperand, opText, rightOperand )

The abstract operation EvaluateStringOrNumericBinaryExpression takes arguments leftOperand (a Parse Node), opText (a sequence of Unicode code points), and rightOperand (a Parse Node) and returns either a normal completion containing either a String, a BigInt, or a Number, or an abrupt completion. It performs the following steps when called:

  1. Let lRef be ? Evaluation of leftOperand.
  2. Let lVal be ? GetValue(lRef).
  3. Let rRef be ? Evaluation of rightOperand.
  4. Let rVal be ? GetValue(rRef).
  5. Return ? ApplyStringOrNumericBinaryOperator(lVal, opText, rVal).

13.15.5 Destructuring Assignment

Supplemental Syntax

In certain circumstances when processing an instance of the production
AssignmentExpression : LeftHandSideExpression = AssignmentExpression
the interpretation of LeftHandSideExpression is refined using the following grammar:

AssignmentPattern[Yield, Await] : ObjectAssignmentPattern[?Yield, ?Await] ArrayAssignmentPattern[?Yield, ?Await] ObjectAssignmentPattern[Yield, Await] : { } { AssignmentRestProperty[?Yield, ?Await] } { AssignmentPropertyList[?Yield, ?Await] } { AssignmentPropertyList[?Yield, ?Await] , AssignmentRestProperty[?Yield, ?Await]opt } ArrayAssignmentPattern[Yield, Await] : [ Elisionopt AssignmentRestElement[?Yield, ?Await]opt ] [ AssignmentElementList[?Yield, ?Await] ] [ AssignmentElementList[?Yield, ?Await] , Elisionopt AssignmentRestElement[?Yield, ?Await]opt ] AssignmentRestProperty[Yield, Await] : ... DestructuringAssignmentTarget[?Yield, ?Await] AssignmentPropertyList[Yield, Await] : AssignmentProperty[?Yield, ?Await] AssignmentPropertyList[?Yield, ?Await] , AssignmentProperty[?Yield, ?Await] AssignmentElementList[Yield, Await] : AssignmentElisionElement[?Yield, ?Await] AssignmentElementList[?Yield, ?Await] , AssignmentElisionElement[?Yield, ?Await] AssignmentElisionElement[Yield, Await] : Elisionopt AssignmentElement[?Yield, ?Await] AssignmentProperty[Yield, Await] : IdentifierReference[?Yield, ?Await] Initializer[+In, ?Yield, ?Await]opt PropertyName[?Yield, ?Await] : AssignmentElement[?Yield, ?Await] AssignmentElement[Yield, Await] : DestructuringAssignmentTarget[?Yield, ?Await] Initializer[+In, ?Yield, ?Await]opt AssignmentRestElement[Yield, Await] : ... DestructuringAssignmentTarget[?Yield, ?Await] DestructuringAssignmentTarget[Yield, Await] : LeftHandSideExpression[?Yield, ?Await]

13.15.5.1 Static Semantics: Early Errors

AssignmentProperty : IdentifierReference Initializeropt AssignmentRestProperty : ... DestructuringAssignmentTarget DestructuringAssignmentTarget : LeftHandSideExpression

13.15.5.2 Runtime Semantics: DestructuringAssignmentEvaluation

The syntax-directed operation DestructuringAssignmentEvaluation takes argument value (an ECMAScript language value) and returns either a normal completion containing unused or an abrupt completion. It is defined piecewise over the following productions:

ObjectAssignmentPattern : { }
  1. Perform ? RequireObjectCoercible(value).
  2. Return unused.
ObjectAssignmentPattern : { AssignmentPropertyList } { AssignmentPropertyList , }
  1. Perform ? RequireObjectCoercible(value).
  2. Perform ? PropertyDestructuringAssignmentEvaluation of AssignmentPropertyList with argument value.
  3. Return unused.
ObjectAssignmentPattern : { AssignmentRestProperty }
  1. Perform ? RequireObjectCoercible(value).
  2. Let excludedNames be a new empty List.
  3. Return ? RestDestructuringAssignmentEvaluation of AssignmentRestProperty with arguments value and excludedNames.
ObjectAssignmentPattern : { AssignmentPropertyList , AssignmentRestProperty }
  1. Perform ? RequireObjectCoercible(value).
  2. Let excludedNames be ? PropertyDestructuringAssignmentEvaluation of AssignmentPropertyList with argument value.
  3. Return ? RestDestructuringAssignmentEvaluation of AssignmentRestProperty with arguments value and excludedNames.
ArrayAssignmentPattern : [ ]
  1. Let iteratorRecord be ? GetIterator(value, sync).
  2. Return ? IteratorClose(iteratorRecord, NormalCompletion(unused)).
ArrayAssignmentPattern : [ Elision ]
  1. Let iteratorRecord be ? GetIterator(value, sync).
  2. Let result be Completion(IteratorDestructuringAssignmentEvaluation of Elision with argument iteratorRecord).
  3. If iteratorRecord.[[Done]] is false, return ? IteratorClose(iteratorRecord, result).
  4. Return result.
ArrayAssignmentPattern : [ Elisionopt AssignmentRestElement ]
  1. Let iteratorRecord be ? GetIterator(value, sync).
  2. If Elision is present, then
    1. Let status be Completion(IteratorDestructuringAssignmentEvaluation of Elision with argument iteratorRecord).
    2. If status is an abrupt completion, then
      1. Assert: iteratorRecord.[[Done]] is true.
      2. Return ? status.
  3. Let result be Completion(IteratorDestructuringAssignmentEvaluation of AssignmentRestElement with argument iteratorRecord).
  4. If iteratorRecord.[[Done]] is false, return ? IteratorClose(iteratorRecord, result).
  5. Return result.
ArrayAssignmentPattern : [ AssignmentElementList ]
  1. Let iteratorRecord be ? GetIterator(value, sync).
  2. Let result be Completion(IteratorDestructuringAssignmentEvaluation of AssignmentElementList with argument iteratorRecord).
  3. If iteratorRecord.[[Done]] is false, return ? IteratorClose(iteratorRecord, result).
  4. Return result.
ArrayAssignmentPattern : [ AssignmentElementList , Elisionopt AssignmentRestElementopt ]
  1. Let iteratorRecord be ? GetIterator(value, sync).
  2. Let status be Completion(IteratorDestructuringAssignmentEvaluation of AssignmentElementList with argument iteratorRecord).
  3. If status is an abrupt completion, then
    1. If iteratorRecord.[[Done]] is false, return ? IteratorClose(iteratorRecord, status).
    2. Return ? status.
  4. If Elision is present, then
    1. Set status to Completion(IteratorDestructuringAssignmentEvaluation of Elision with argument iteratorRecord).
    2. If status is an abrupt completion, then
      1. Assert: iteratorRecord.[[Done]] is true.
      2. Return ? status.
  5. If AssignmentRestElement is present, then
    1. Set status to Completion(IteratorDestructuringAssignmentEvaluation of AssignmentRestElement with argument iteratorRecord).
  6. If iteratorRecord.[[Done]] is false, return ? IteratorClose(iteratorRecord, status).
  7. Return ? status.

13.15.5.3 Runtime Semantics: PropertyDestructuringAssignmentEvaluation

The syntax-directed operation PropertyDestructuringAssignmentEvaluation takes argument value (an ECMAScript language value) and returns either a normal completion containing a List of property keys or an abrupt completion. It collects a list of all destructured property keys. It is defined piecewise over the following productions:

AssignmentPropertyList : AssignmentPropertyList , AssignmentProperty
  1. Let propertyNames be ? PropertyDestructuringAssignmentEvaluation of AssignmentPropertyList with argument value.
  2. Let nextNames be ? PropertyDestructuringAssignmentEvaluation of AssignmentProperty with argument value.
  3. Return the list-concatenation of propertyNames and nextNames.
AssignmentProperty : IdentifierReference Initializeropt
  1. Let P be the StringValue of IdentifierReference.
  2. Let lRef be ? ResolveBinding(P).
  3. Let v be ? GetV(value, P).
  4. If Initializer is present and v is undefined, then
    1. If IsAnonymousFunctionDefinition(Initializer) is true, then
      1. Set v to ? NamedEvaluation of Initializer with argument P.
    2. Else,
      1. Let defaultValue be ? Evaluation of Initializer.
      2. Set v to ? GetValue(defaultValue).
  5. Perform ? PutValue(lRef, v).
  6. Return « P ».
AssignmentProperty : PropertyName : AssignmentElement
  1. Let name be ? Evaluation of PropertyName.
  2. Perform ? KeyedDestructuringAssignmentEvaluation of AssignmentElement with arguments value and name.
  3. Return « name ».

13.15.5.4 Runtime Semantics: RestDestructuringAssignmentEvaluation

The syntax-directed operation RestDestructuringAssignmentEvaluation takes arguments value (an ECMAScript language value) and excludedNames (a List of property keys) and returns either a normal completion containing unused or an abrupt completion. It is defined piecewise over the following productions:

AssignmentRestProperty : ... DestructuringAssignmentTarget
  1. Let lRef be ? Evaluation of DestructuringAssignmentTarget.
  2. Let restObj be OrdinaryObjectCreate(%Object.prototype%).
  3. Perform ? CopyDataProperties(restObj, value, excludedNames).
  4. Return ? PutValue(lRef, restObj).

13.15.5.5 Runtime Semantics: IteratorDestructuringAssignmentEvaluation

The syntax-directed operation IteratorDestructuringAssignmentEvaluation takes argument iteratorRecord (an Iterator Record) and returns either a normal completion containing unused or an abrupt completion. It is defined piecewise over the following productions:

AssignmentElementList : AssignmentElisionElement
  1. Return ? IteratorDestructuringAssignmentEvaluation of AssignmentElisionElement with argument iteratorRecord.
AssignmentElementList : AssignmentElementList , AssignmentElisionElement
  1. Perform ? IteratorDestructuringAssignmentEvaluation of AssignmentElementList with argument iteratorRecord.
  2. Return ? IteratorDestructuringAssignmentEvaluation of AssignmentElisionElement with argument iteratorRecord.
AssignmentElisionElement : AssignmentElement
  1. Return ? IteratorDestructuringAssignmentEvaluation of AssignmentElement with argument iteratorRecord.
AssignmentElisionElement : Elision AssignmentElement
  1. Perform ? IteratorDestructuringAssignmentEvaluation of Elision with argument iteratorRecord.
  2. Return ? IteratorDestructuringAssignmentEvaluation of AssignmentElement with argument iteratorRecord.
Elision : ,
  1. If iteratorRecord.[[Done]] is false, then
    1. Perform ? IteratorStep(iteratorRecord).
  2. Return unused.
Elision : Elision ,
  1. Perform ? IteratorDestructuringAssignmentEvaluation of Elision with argument iteratorRecord.
  2. If iteratorRecord.[[Done]] is false, then
    1. Perform ? IteratorStep(iteratorRecord).
  3. Return unused.
AssignmentElement : DestructuringAssignmentTarget Initializeropt
  1. If DestructuringAssignmentTarget is neither an ObjectLiteral nor an ArrayLiteral, then
    1. Let lRef be ? Evaluation of DestructuringAssignmentTarget.
  2. Let value be undefined.
  3. If iteratorRecord.[[Done]] is false, then
    1. Let next be ? IteratorStepValue(iteratorRecord).
    2. If next is not done, then
      1. Set value to next.
  4. If Initializer is present and value is undefined, then
    1. If IsAnonymousFunctionDefinition(Initializer) is true and IsIdentifierRef of DestructuringAssignmentTarget is true, then
      1. Let target be the StringValue of DestructuringAssignmentTarget.
      2. Let v be ? NamedEvaluation of Initializer with argument target.
    2. Else,
      1. Let defaultValue be ? Evaluation of Initializer.
      2. Let v be ? GetValue(defaultValue).
  5. Else,
    1. Let v be value.
  6. If DestructuringAssignmentTarget is either an ObjectLiteral or an ArrayLiteral, then
    1. Let nestedAssignmentPattern be the AssignmentPattern that is covered by DestructuringAssignmentTarget.
    2. Return ? DestructuringAssignmentEvaluation of nestedAssignmentPattern with argument v.
  7. Return ? PutValue(lRef, v).
Note

Left to right evaluation order is maintained by evaluating a DestructuringAssignmentTarget that is not a destructuring pattern prior to accessing the iterator or evaluating the Initializer.

AssignmentRestElement : ... DestructuringAssignmentTarget
  1. If DestructuringAssignmentTarget is neither an ObjectLiteral nor an ArrayLiteral, then
    1. Let lRef be ? Evaluation of DestructuringAssignmentTarget.
  2. Let A be ! ArrayCreate(0).
  3. Let n be 0.
  4. Repeat, while iteratorRecord.[[Done]] is false,
    1. Let next be ? IteratorStepValue(iteratorRecord).
    2. If next is not done, then
      1. Perform ! CreateDataPropertyOrThrow(A, ! ToString(𝔽(n)), next).
      2. Set n to n + 1.
  5. If DestructuringAssignmentTarget is neither an ObjectLiteral nor an ArrayLiteral, then
    1. Return ? PutValue(lRef, A).
  6. Let nestedAssignmentPattern be the AssignmentPattern that is covered by DestructuringAssignmentTarget.
  7. Return ? DestructuringAssignmentEvaluation of nestedAssignmentPattern with argument A.

13.15.5.6 Runtime Semantics: KeyedDestructuringAssignmentEvaluation

The syntax-directed operation KeyedDestructuringAssignmentEvaluation takes arguments value (an ECMAScript language value) and propertyName (a property key) and returns either a normal completion containing unused or an abrupt completion. It is defined piecewise over the following productions:

AssignmentElement : DestructuringAssignmentTarget Initializeropt
  1. If DestructuringAssignmentTarget is neither an ObjectLiteral nor an ArrayLiteral, then
    1. Let lRef be ? Evaluation of DestructuringAssignmentTarget.
  2. Let v be ? GetV(value, propertyName).
  3. If Initializer is present and v is undefined, then
    1. If IsAnonymousFunctionDefinition(Initializer) is true and IsIdentifierRef of DestructuringAssignmentTarget is true, then
      1. Let target be the StringValue of DestructuringAssignmentTarget.
      2. Let rhsValue be ? NamedEvaluation of Initializer with argument target.
    2. Else,
      1. Let defaultValue be ? Evaluation of Initializer.
      2. Let rhsValue be ? GetValue(defaultValue).
  4. Else,
    1. Let rhsValue be v.
  5. If DestructuringAssignmentTarget is either an ObjectLiteral or an ArrayLiteral, then
    1. Let assignmentPattern be the AssignmentPattern that is covered by DestructuringAssignmentTarget.
    2. Return ? DestructuringAssignmentEvaluation of assignmentPattern with argument rhsValue.
  6. Return ? PutValue(lRef, rhsValue).

13.16 Comma Operator ( , )

Syntax

Expression[In, Yield, Await] : AssignmentExpression[?In, ?Yield, ?Await] Expression[?In, ?Yield, ?Await] , AssignmentExpression[?In, ?Yield, ?Await]

13.16.1 Runtime Semantics: Evaluation

Expression : Expression , AssignmentExpression
  1. Let lRef be ? Evaluation of Expression.
  2. Perform ? GetValue(lRef).
  3. Let rRef be ? Evaluation of AssignmentExpression.
  4. Return ? GetValue(rRef).
Note

GetValue must be called even though its value is not used because it may have observable side-effects.

14 ECMAScript Language: Statements and Declarations

Syntax

Statement[Yield, Await, Return] : BlockStatement[?Yield, ?Await, ?Return] VariableStatement[?Yield, ?Await] EmptyStatement ExpressionStatement[?Yield, ?Await] IfStatement[?Yield, ?Await, ?Return] BreakableStatement[?Yield, ?Await, ?Return] ContinueStatement[?Yield, ?Await] BreakStatement[?Yield, ?Await] [+Return] ReturnStatement[?Yield, ?Await] WithStatement[?Yield, ?Await, ?Return] LabelledStatement[?Yield, ?Await, ?Return] ThrowStatement[?Yield, ?Await] TryStatement[?Yield, ?Await, ?Return] DebuggerStatement Declaration[Yield, Await] : HoistableDeclaration[?Yield, ?Await, ~Default] ClassDeclaration[?Yield, ?Await, ~Default] LexicalDeclaration[+In, ?Yield, ?Await] HoistableDeclaration[Yield, Await, Default] : FunctionDeclaration[?Yield, ?Await, ?Default] GeneratorDeclaration[?Yield, ?Await, ?Default] AsyncFunctionDeclaration[?Yield, ?Await, ?Default] AsyncGeneratorDeclaration[?Yield, ?Await, ?Default] BreakableStatement[Yield, Await, Return] : IterationStatement[?Yield, ?Await, ?Return] SwitchStatement[?Yield, ?Await, ?Return]

14.1 Statement Semantics

14.1.1 Runtime Semantics: Evaluation

HoistableDeclaration : GeneratorDeclaration AsyncFunctionDeclaration AsyncGeneratorDeclaration
  1. Return empty.
HoistableDeclaration : FunctionDeclaration
  1. Return ? Evaluation of FunctionDeclaration.
BreakableStatement : IterationStatement SwitchStatement
  1. Let newLabelSet be a new empty List.
  2. Return ? LabelledEvaluation of this BreakableStatement with argument newLabelSet.

14.2 Block

Syntax

BlockStatement[Yield, Await, Return] : Block[?Yield, ?Await, ?Return] Block[Yield, Await, Return] : { StatementList[?Yield, ?Await, ?Return]opt } StatementList[Yield, Await, Return] : StatementListItem[?Yield, ?Await, ?Return] StatementList[?Yield, ?Await, ?Return] StatementListItem[?Yield, ?Await, ?Return] StatementListItem[Yield, Await, Return] : Statement[?Yield, ?Await, ?Return] Declaration[?Yield, ?Await]

14.2.1 Static Semantics: Early Errors

Block : { StatementList }

14.2.2 Runtime Semantics: Evaluation

Block : { }
  1. Return empty.
Block : { StatementList }
  1. Let oldEnv be the running execution context's LexicalEnvironment.
  2. Let blockEnv be NewDeclarativeEnvironment(oldEnv).
  3. Perform BlockDeclarationInstantiation(StatementList, blockEnv).
  4. Set the running execution context's LexicalEnvironment to blockEnv.
  5. Let blockValue be Completion(Evaluation of StatementList).
  6. Set the running execution context's LexicalEnvironment to oldEnv.
  7. Return ? blockValue.
Note 1

No matter how control leaves the Block the LexicalEnvironment is always restored to its former state.

StatementList : StatementList StatementListItem
  1. Let sl be ? Evaluation of StatementList.
  2. Let s be Completion(Evaluation of StatementListItem).
  3. Return ? UpdateEmpty(s, sl).
Note 2

The value of a StatementList is the value of the last value-producing item in the StatementList. For example, the following calls to the eval function all return the value 1:

eval("1;;;;;")
eval("1;{}")
eval("1;var a;")

14.2.3 BlockDeclarationInstantiation ( code, env )

The abstract operation BlockDeclarationInstantiation takes arguments code (a Parse Node) and env (a Declarative Environment Record) and returns unused. code is the Parse Node corresponding to the body of the block. env is the Environment Record in which bindings are to be created.

Note

When a Block or CaseBlock is evaluated a new Declarative Environment Record is created and bindings for each block scoped variable, constant, function, or class declared in the block are instantiated in the Environment Record.

It performs the following steps when called:

  1. Let declarations be the LexicallyScopedDeclarations of code.
  2. Let privateEnv be the running execution context's PrivateEnvironment.
  3. For each element d of declarations, do
    1. For each element dn of the BoundNames of d, do
      1. If IsConstantDeclaration of d is true, then
        1. Perform ! env.CreateImmutableBinding(dn, true).
      2. Else,
        1. Perform ! env.CreateMutableBinding(dn, false). NOTE: This step is replaced in section B.3.2.6.
    2. If d is either a FunctionDeclaration, a GeneratorDeclaration, an AsyncFunctionDeclaration, or an AsyncGeneratorDeclaration, then
      1. Let fn be the sole element of the BoundNames of d.
      2. Let fo be InstantiateFunctionObject of d with arguments env and privateEnv.
      3. Perform ! env.InitializeBinding(fn, fo). NOTE: This step is replaced in section B.3.2.6.
  4. Return unused.

14.3 Declarations and the Variable Statement

14.3.1 Let and Const Declarations

Note

let and const declarations define variables that are scoped to the running execution context's LexicalEnvironment. The variables are created when their containing Environment Record is instantiated but may not be accessed in any way until the variable's LexicalBinding is evaluated. A variable defined by a LexicalBinding with an Initializer is assigned the value of its Initializer's AssignmentExpression when the LexicalBinding is evaluated, not when the variable is created. If a LexicalBinding in a let declaration does not have an Initializer the variable is assigned the value undefined when the LexicalBinding is evaluated.

Syntax

LexicalDeclaration[In, Yield, Await] : LetOrConst BindingList[?In, ?Yield, ?Await] ; LetOrConst : let const BindingList[In, Yield, Await] : LexicalBinding[?In, ?Yield, ?Await] BindingList[?In, ?Yield, ?Await] , LexicalBinding[?In, ?Yield, ?Await] LexicalBinding[In, Yield, Await] : BindingIdentifier[?Yield, ?Await] Initializer[?In, ?Yield, ?Await]opt BindingPattern[?Yield, ?Await] Initializer[?In, ?Yield, ?Await]

14.3.1.1 Static Semantics: Early Errors

LexicalDeclaration : LetOrConst BindingList ; LexicalBinding : BindingIdentifier Initializeropt

14.3.1.2 Runtime Semantics: Evaluation

LexicalDeclaration : LetOrConst BindingList ;
  1. Perform ? Evaluation of BindingList.
  2. Return empty.
BindingList : BindingList , LexicalBinding
  1. Perform ? Evaluation of BindingList.
  2. Return ? Evaluation of LexicalBinding.
LexicalBinding : BindingIdentifier
  1. Let lhs be ! ResolveBinding(StringValue of BindingIdentifier).
  2. Perform ! InitializeReferencedBinding(lhs, undefined).
  3. Return empty.
Note

A static semantics rule ensures that this form of LexicalBinding never occurs in a const declaration.

LexicalBinding : BindingIdentifier Initializer
  1. Let bindingId be the StringValue of BindingIdentifier.
  2. Let lhs be ! ResolveBinding(bindingId).
  3. If IsAnonymousFunctionDefinition(Initializer) is true, then
    1. Let value be ? NamedEvaluation of Initializer with argument bindingId.
  4. Else,
    1. Let rhs be ? Evaluation of Initializer.
    2. Let value be ? GetValue(rhs).
  5. Perform ! InitializeReferencedBinding(lhs, value).
  6. Return empty.
LexicalBinding : BindingPattern Initializer
  1. Let rhs be ? Evaluation of Initializer.
  2. Let value be ? GetValue(rhs).
  3. Let env be the running execution context's LexicalEnvironment.
  4. Return ? BindingInitialization of BindingPattern with arguments value and env.

14.3.2 Variable Statement

Note

A var statement declares variables that are scoped to the running execution context's VariableEnvironment. Var variables are created when their containing Environment Record is instantiated and are initialized to undefined when created. Within the scope of any VariableEnvironment a common BindingIdentifier may appear in more than one VariableDeclaration but those declarations collectively define only one variable. A variable defined by a VariableDeclaration with an Initializer is assigned the value of its Initializer's AssignmentExpression when the VariableDeclaration is executed, not when the variable is created.

Syntax

VariableStatement[Yield, Await] : var VariableDeclarationList[+In, ?Yield, ?Await] ; VariableDeclarationList[In, Yield, Await] : VariableDeclaration[?In, ?Yield, ?Await] VariableDeclarationList[?In, ?Yield, ?Await] , VariableDeclaration[?In, ?Yield, ?Await] VariableDeclaration[In, Yield, Await] : BindingIdentifier[?Yield, ?Await] Initializer[?In, ?Yield, ?Await]opt BindingPattern[?Yield, ?Await] Initializer[?In, ?Yield, ?Await]

14.3.2.1 Runtime Semantics: Evaluation

VariableStatement : var VariableDeclarationList ;
  1. Perform ? Evaluation of VariableDeclarationList.
  2. Return empty.
VariableDeclarationList : VariableDeclarationList , VariableDeclaration
  1. Perform ? Evaluation of VariableDeclarationList.
  2. Return ? Evaluation of VariableDeclaration.
VariableDeclaration : BindingIdentifier
  1. Return empty.
VariableDeclaration : BindingIdentifier Initializer
  1. Let bindingId be the StringValue of BindingIdentifier.
  2. Let lhs be ? ResolveBinding(bindingId).
  3. If IsAnonymousFunctionDefinition(Initializer) is true, then
    1. Let value be ? NamedEvaluation of Initializer with argument bindingId.
  4. Else,
    1. Let rhs be ? Evaluation of Initializer.
    2. Let value be ? GetValue(rhs).
  5. Perform ? PutValue(lhs, value).
  6. Return empty.
Note

If a VariableDeclaration is nested within a with statement and the BindingIdentifier in the VariableDeclaration is the same as a property name of the binding object of the with statement's Object Environment Record, then step 5 will assign value to the property instead of assigning to the VariableEnvironment binding of the Identifier.

VariableDeclaration : BindingPattern Initializer
  1. Let rhs be ? Evaluation of Initializer.
  2. Let rVal be ? GetValue(rhs).
  3. Return ? BindingInitialization of BindingPattern with arguments rVal and undefined.

14.3.3 Destructuring Binding Patterns

Syntax

BindingPattern[Yield, Await] : ObjectBindingPattern[?Yield, ?Await] ArrayBindingPattern[?Yield, ?Await] ObjectBindingPattern[Yield, Await] : { } { BindingRestProperty[?Yield, ?Await] } { BindingPropertyList[?Yield, ?Await] } { BindingPropertyList[?Yield, ?Await] , BindingRestProperty[?Yield, ?Await]opt } ArrayBindingPattern[Yield, Await] : [ Elisionopt BindingRestElement[?Yield, ?Await]opt ] [ BindingElementList[?Yield, ?Await] ] [ BindingElementList[?Yield, ?Await] , Elisionopt BindingRestElement[?Yield, ?Await]opt ] BindingRestProperty[Yield, Await] : ... BindingIdentifier[?Yield, ?Await] BindingPropertyList[Yield, Await] : BindingProperty[?Yield, ?Await] BindingPropertyList[?Yield, ?Await] , BindingProperty[?Yield, ?Await] BindingElementList[Yield, Await] : BindingElisionElement[?Yield, ?Await] BindingElementList[?Yield, ?Await] , BindingElisionElement[?Yield, ?Await] BindingElisionElement[Yield, Await] : Elisionopt BindingElement[?Yield, ?Await] BindingProperty[Yield, Await] : SingleNameBinding[?Yield, ?Await] PropertyName[?Yield, ?Await] : BindingElement[?Yield, ?Await] BindingElement[Yield, Await] : SingleNameBinding[?Yield, ?Await] BindingPattern[?Yield, ?Await] Initializer[+In, ?Yield, ?Await]opt SingleNameBinding[Yield, Await] : BindingIdentifier[?Yield, ?Await] Initializer[+In, ?Yield, ?Await]opt BindingRestElement[Yield, Await] : ... BindingIdentifier[?Yield, ?Await] ... BindingPattern[?Yield, ?Await]

14.3.3.1 Runtime Semantics: PropertyBindingInitialization

The syntax-directed operation PropertyBindingInitialization takes arguments value (an ECMAScript language value) and environment (an Environment Record or undefined) and returns either a normal completion containing a List of property keys or an abrupt completion. It collects a list of all bound property names. It is defined piecewise over the following productions:

BindingPropertyList : BindingPropertyList , BindingProperty
  1. Let boundNames be ? PropertyBindingInitialization of BindingPropertyList with arguments value and environment.
  2. Let nextNames be ? PropertyBindingInitialization of BindingProperty with arguments value and environment.
  3. Return the list-concatenation of boundNames and nextNames.
BindingProperty : SingleNameBinding
  1. Let name be the sole element of the BoundNames of SingleNameBinding.
  2. Perform ? KeyedBindingInitialization of SingleNameBinding with arguments value, environment, and name.
  3. Return « name ».
BindingProperty : PropertyName : BindingElement
  1. Let P be ? Evaluation of PropertyName.
  2. Perform ? KeyedBindingInitialization of BindingElement with arguments value, environment, and P.
  3. Return « P ».

14.3.3.2 Runtime Semantics: RestBindingInitialization

The syntax-directed operation RestBindingInitialization takes arguments value (an ECMAScript language value), environment (an Environment Record or undefined), and excludedNames (a List of property keys) and returns either a normal completion containing unused or an abrupt completion. It is defined piecewise over the following productions:

BindingRestProperty : ... BindingIdentifier
  1. Let lhs be ? ResolveBinding(StringValue of BindingIdentifier, environment).
  2. Let restObj be OrdinaryObjectCreate(%Object.prototype%).
  3. Perform ? CopyDataProperties(restObj, value, excludedNames).
  4. If environment is undefined, return ? PutValue(lhs, restObj).
  5. Return ? InitializeReferencedBinding(lhs, restObj).

14.3.3.3 Runtime Semantics: KeyedBindingInitialization

The syntax-directed operation KeyedBindingInitialization takes arguments value (an ECMAScript language value), environment (an Environment Record or undefined), and propertyName (a property key) and returns either a normal completion containing unused or an abrupt completion.

Note

When undefined is passed for environment it indicates that a PutValue operation should be used to assign the initialization value. This is the case for formal parameter lists of non-strict functions. In that case the formal parameter bindings are preinitialized in order to deal with the possibility of multiple parameters with the same name.

It is defined piecewise over the following productions:

BindingElement : BindingPattern Initializeropt
  1. Let v be ? GetV(value, propertyName).
  2. If Initializer is present and v is undefined, then
    1. Let defaultValue be ? Evaluation of Initializer.
    2. Set v to ? GetValue(defaultValue).
  3. Return ? BindingInitialization of BindingPattern with arguments v and environment.
SingleNameBinding : BindingIdentifier Initializeropt
  1. Let bindingId be the StringValue of BindingIdentifier.
  2. Let lhs be ? ResolveBinding(bindingId, environment).
  3. Let v be ? GetV(value, propertyName).
  4. If Initializer is present and v is undefined, then
    1. If IsAnonymousFunctionDefinition(Initializer) is true, then
      1. Set v to ? NamedEvaluation of Initializer with argument bindingId.
    2. Else,
      1. Let defaultValue be ? Evaluation of Initializer.
      2. Set v to ? GetValue(defaultValue).
  5. If environment is undefined, return ? PutValue(lhs, v).
  6. Return ? InitializeReferencedBinding(lhs, v).

14.4 Empty Statement

Syntax

EmptyStatement : ;

14.4.1 Runtime Semantics: Evaluation

EmptyStatement : ;
  1. Return empty.

14.5 Expression Statement

Syntax

ExpressionStatement[Yield, Await] : [lookahead ∉ { {, function, async [no LineTerminator here] function, class, let [ }] Expression[+In, ?Yield, ?Await] ; Note

An ExpressionStatement cannot start with a U+007B (LEFT CURLY BRACKET) because that might make it ambiguous with a Block. An ExpressionStatement cannot start with the function or class keywords because that would make it ambiguous with a FunctionDeclaration, a GeneratorDeclaration, or a ClassDeclaration. An ExpressionStatement cannot start with async function because that would make it ambiguous with an AsyncFunctionDeclaration or a AsyncGeneratorDeclaration. An ExpressionStatement cannot start with the two token sequence let [ because that would make it ambiguous with a let LexicalDeclaration whose first LexicalBinding was an ArrayBindingPattern.

14.5.1 Runtime Semantics: Evaluation

ExpressionStatement : Expression ;
  1. Let exprRef be ? Evaluation of Expression.
  2. Return ? GetValue(exprRef).

14.6 The if Statement

Syntax

IfStatement[Yield, Await, Return] : if ( Expression[+In, ?Yield, ?Await] ) Statement[?Yield, ?Await, ?Return] else Statement[?Yield, ?Await, ?Return] if ( Expression[+In, ?Yield, ?Await] ) Statement[?Yield, ?Await, ?Return] [lookahead ≠ else] Note
The lookahead-restriction [lookahead ≠ else] resolves the classic "dangling else" problem in the usual way. That is, when the choice of associated if is otherwise ambiguous, the else is associated with the nearest (innermost) of the candidate ifs

14.6.1 Static Semantics: Early Errors

IfStatement : if ( Expression ) Statement else Statement IfStatement : if ( Expression ) Statement Note

It is only necessary to apply this rule if the extension specified in B.3.1 is implemented.

14.6.2 Runtime Semantics: Evaluation

IfStatement : if ( Expression ) Statement else Statement
  1. Let exprRef be ? Evaluation of Expression.
  2. Let exprValue be ToBoolean(? GetValue(exprRef)).
  3. If exprValue is true, then
    1. Let stmtCompletion be Completion(Evaluation of the first Statement).
  4. Else,
    1. Let stmtCompletion be Completion(Evaluation of the second Statement).
  5. Return ? UpdateEmpty(stmtCompletion, undefined).
IfStatement : if ( Expression ) Statement
  1. Let exprRef be ? Evaluation of Expression.
  2. Let exprValue be ToBoolean(? GetValue(exprRef)).
  3. If exprValue is false, then
    1. Return undefined.
  4. Else,
    1. Let stmtCompletion be Completion(Evaluation of Statement).
    2. Return ? UpdateEmpty(stmtCompletion, undefined).

14.7 Iteration Statements

Syntax

IterationStatement[Yield, Await, Return] : DoWhileStatement[?Yield, ?Await, ?Return] WhileStatement[?Yield, ?Await, ?Return] ForStatement[?Yield, ?Await, ?Return] ForInOfStatement[?Yield, ?Await, ?Return]

14.7.1 Semantics

14.7.1.1 LoopContinues ( completion, labelSet )

The abstract operation LoopContinues takes arguments completion (a Completion Record) and labelSet (a List of Strings) and returns a Boolean. It performs the following steps when called:

  1. If completion is a normal completion, return true.
  2. If completion is not a continue completion, return false.
  3. If completion.[[Target]] is empty, return true.
  4. If labelSet contains completion.[[Target]], return true.
  5. Return false.
Note

Within the Statement part of an IterationStatement a ContinueStatement may be used to begin a new iteration.

14.7.1.2 Runtime Semantics: LoopEvaluation

The syntax-directed operation LoopEvaluation takes argument labelSet (a List of Strings) and returns either a normal completion containing an ECMAScript language value or an abrupt completion. It is defined piecewise over the following productions:

IterationStatement : DoWhileStatement
  1. Return ? DoWhileLoopEvaluation of DoWhileStatement with argument labelSet.
IterationStatement : WhileStatement
  1. Return ? WhileLoopEvaluation of WhileStatement with argument labelSet.
IterationStatement : ForStatement
  1. Return ? ForLoopEvaluation of ForStatement with argument labelSet.
IterationStatement : ForInOfStatement
  1. Return ? ForInOfLoopEvaluation of ForInOfStatement with argument labelSet.

14.7.2 The do-while Statement

Syntax

DoWhileStatement[Yield, Await, Return] : do Statement[?Yield, ?Await, ?Return] while ( Expression[+In, ?Yield, ?Await] ) ;

14.7.2.1 Static Semantics: Early Errors

DoWhileStatement : do Statement while ( Expression ) ; Note

It is only necessary to apply this rule if the extension specified in B.3.1 is implemented.

14.7.2.2 Runtime Semantics: DoWhileLoopEvaluation

The syntax-directed operation DoWhileLoopEvaluation takes argument labelSet (a List of Strings) and returns either a normal completion containing an ECMAScript language value or an abrupt completion. It is defined piecewise over the following productions:

DoWhileStatement : do Statement while ( Expression ) ;
  1. Let V be undefined.
  2. Repeat,
    1. Let stmtResult be Completion(Evaluation of Statement).
    2. If LoopContinues(stmtResult, labelSet) is false, return ? UpdateEmpty(stmtResult, V).
    3. If stmtResult.[[Value]] is not empty, set V to stmtResult.[[Value]].
    4. Let exprRef be ? Evaluation of Expression.
    5. Let exprValue be ? GetValue(exprRef).
    6. If ToBoolean(exprValue) is false, return V.

14.7.3 The while Statement

Syntax

WhileStatement[Yield, Await, Return] : while ( Expression[+In, ?Yield, ?Await] ) Statement[?Yield, ?Await, ?Return]

14.7.3.1 Static Semantics: Early Errors

WhileStatement : while ( Expression ) Statement Note

It is only necessary to apply this rule if the extension specified in B.3.1 is implemented.

14.7.3.2 Runtime Semantics: WhileLoopEvaluation

The syntax-directed operation WhileLoopEvaluation takes argument labelSet (a List of Strings) and returns either a normal completion containing an ECMAScript language value or an abrupt completion. It is defined piecewise over the following productions:

WhileStatement : while ( Expression ) Statement
  1. Let V be undefined.
  2. Repeat,
    1. Let exprRef be ? Evaluation of Expression.
    2. Let exprValue be ? GetValue(exprRef).
    3. If ToBoolean(exprValue) is false, return V.
    4. Let stmtResult be Completion(Evaluation of Statement).
    5. If LoopContinues(stmtResult, labelSet) is false, return ? UpdateEmpty(stmtResult, V).
    6. If stmtResult.[[Value]] is not empty, set V to stmtResult.[[Value]].

14.7.4 The for Statement

Syntax

ForStatement[Yield, Await, Return] : for ( [lookahead ≠ let [] Expression[~In, ?Yield, ?Await]opt ; Expression[+In, ?Yield, ?Await]opt ; Expression[+In, ?Yield, ?Await]opt ) Statement[?Yield, ?Await, ?Return] for ( var VariableDeclarationList[~In, ?Yield, ?Await] ; Expression[+In, ?Yield, ?Await]opt ; Expression[+In, ?Yield, ?Await]opt ) Statement[?Yield, ?Await, ?Return] for ( LexicalDeclaration[~In, ?Yield, ?Await] Expression[+In, ?Yield, ?Await]opt ; Expression[+In, ?Yield, ?Await]opt ) Statement[?Yield, ?Await, ?Return]

14.7.4.1 Static Semantics: Early Errors

ForStatement : for ( Expressionopt ; Expressionopt ; Expressionopt ) Statement for ( var VariableDeclarationList ; Expressionopt ; Expressionopt ) Statement for ( LexicalDeclaration Expressionopt ; Expressionopt ) Statement Note

It is only necessary to apply this rule if the extension specified in B.3.1 is implemented.

ForStatement : for ( LexicalDeclaration Expressionopt ; Expressionopt ) Statement

14.7.4.2 Runtime Semantics: ForLoopEvaluation

The syntax-directed operation ForLoopEvaluation takes argument labelSet (a List of Strings) and returns either a normal completion containing an ECMAScript language value or an abrupt completion. It is defined piecewise over the following productions:

ForStatement : for ( Expressionopt ; Expressionopt ; Expressionopt ) Statement
  1. If the first Expression is present, then
    1. Let exprRef be ? Evaluation of the first Expression.
    2. Perform ? GetValue(exprRef).
  2. If the second Expression is present, let test be the second Expression; otherwise let test be empty.
  3. If the third Expression is present, let increment be the third Expression; otherwise let increment be empty.
  4. Return ? ForBodyEvaluation(test, increment, Statement, « », labelSet).
ForStatement : for ( var VariableDeclarationList ; Expressionopt ; Expressionopt ) Statement
  1. Perform ? Evaluation of VariableDeclarationList.
  2. If the first Expression is present, let test be the first Expression; otherwise let test be empty.
  3. If the second Expression is present, let increment be the second Expression; otherwise let increment be empty.
  4. Return ? ForBodyEvaluation(test, increment, Statement, « », labelSet).
ForStatement : for ( LexicalDeclaration Expressionopt ; Expressionopt ) Statement
  1. Let oldEnv be the running execution context's LexicalEnvironment.
  2. Let loopEnv be NewDeclarativeEnvironment(oldEnv).
  3. Let isConst be IsConstantDeclaration of LexicalDeclaration.
  4. Let boundNames be the BoundNames of LexicalDeclaration.
  5. For each element dn of boundNames, do
    1. If isConst is true, then
      1. Perform ! loopEnv.CreateImmutableBinding(dn, true).
    2. Else,
      1. Perform ! loopEnv.CreateMutableBinding(dn, false).
  6. Set the running execution context's LexicalEnvironment to loopEnv.
  7. Let forDcl be Completion(Evaluation of LexicalDeclaration).
  8. If forDcl is an abrupt completion, then
    1. Set the running execution context's LexicalEnvironment to oldEnv.
    2. Return ? forDcl.
  9. If isConst is false, let perIterationLets be boundNames; otherwise let perIterationLets be a new empty List.
  10. If the first Expression is present, let test be the first Expression; otherwise let test be empty.
  11. If the second Expression is present, let increment be the second Expression; otherwise let increment be empty.
  12. Let bodyResult be Completion(ForBodyEvaluation(test, increment, Statement, perIterationLets, labelSet)).
  13. Set the running execution context's LexicalEnvironment to oldEnv.
  14. Return ? bodyResult.

14.7.4.3 ForBodyEvaluation ( test, increment, stmt, perIterationBindings, labelSet )

The abstract operation ForBodyEvaluation takes arguments test (an Expression Parse Node or empty), increment (an Expression Parse Node or empty), stmt (a Statement Parse Node), perIterationBindings (a List of Strings), and labelSet (a List of Strings) and returns either a normal completion containing an ECMAScript language value or an abrupt completion. It performs the following steps when called:

  1. Let V be undefined.
  2. Perform ? CreatePerIterationEnvironment(perIterationBindings).
  3. Repeat,
    1. If test is not empty, then
      1. Let testRef be ? Evaluation of test.
      2. Let testValue be ? GetValue(testRef).
      3. If ToBoolean(testValue) is false, return V.
    2. Let result be Completion(Evaluation of stmt).
    3. If LoopContinues(result, labelSet) is false, return ? UpdateEmpty(result, V).
    4. If result.[[Value]] is not empty, set V to result.[[Value]].
    5. Perform ? CreatePerIterationEnvironment(perIterationBindings).
    6. If increment is not empty, then
      1. Let incRef be ? Evaluation of increment.
      2. Perform ? GetValue(incRef).

14.7.4.4 CreatePerIterationEnvironment ( perIterationBindings )

The abstract operation CreatePerIterationEnvironment takes argument perIterationBindings (a List of Strings) and returns either a normal completion containing unused or a throw completion. It performs the following steps when called:

  1. If perIterationBindings has any elements, then
    1. Let lastIterationEnv be the running execution context's LexicalEnvironment.
    2. Let outer be lastIterationEnv.[[OuterEnv]].
    3. Assert: outer is not null.
    4. Let thisIterationEnv be NewDeclarativeEnvironment(outer).
    5. For each element bn of perIterationBindings, do
      1. Perform ! thisIterationEnv.CreateMutableBinding(bn, false).
      2. Let lastValue be ? lastIterationEnv.GetBindingValue(bn, true).
      3. Perform ! thisIterationEnv.InitializeBinding(bn, lastValue).
    6. Set the running execution context's LexicalEnvironment to thisIterationEnv.
  2. Return unused.

14.7.5 The for-in, for-of, and for-await-of Statements

Syntax

ForInOfStatement[Yield, Await, Return] : for ( [lookahead ≠ let [] LeftHandSideExpression[?Yield, ?Await] in Expression[+In, ?Yield, ?Await] ) Statement[?Yield, ?Await, ?Return] for ( var ForBinding[?Yield, ?Await] in Expression[+In, ?Yield, ?Await] ) Statement[?Yield, ?Await, ?Return] for ( ForDeclaration[?Yield, ?Await] in Expression[+In, ?Yield, ?Await] ) Statement[?Yield, ?Await, ?Return] for ( [lookahead ∉ { let, async of }] LeftHandSideExpression[?Yield, ?Await] of AssignmentExpression[+In, ?Yield, ?Await] ) Statement[?Yield, ?Await, ?Return] for ( var ForBinding[?Yield, ?Await] of AssignmentExpression[+In, ?Yield, ?Await] ) Statement[?Yield, ?Await, ?Return] for ( ForDeclaration[?Yield, ?Await] of AssignmentExpression[+In, ?Yield, ?Await] ) Statement[?Yield, ?Await, ?Return] [+Await] for await ( [lookahead ≠ let] LeftHandSideExpression[?Yield, ?Await] of AssignmentExpression[+In, ?Yield, ?Await] ) Statement[?Yield, ?Await, ?Return] [+Await] for await ( var ForBinding[?Yield, ?Await] of AssignmentExpression[+In, ?Yield, ?Await] ) Statement[?Yield, ?Await, ?Return] [+Await] for await ( ForDeclaration[?Yield, ?Await] of AssignmentExpression[+In, ?Yield, ?Await] ) Statement[?Yield, ?Await, ?Return] ForDeclaration[Yield, Await] : LetOrConst ForBinding[?Yield, ?Await] ForBinding[Yield, Await] : BindingIdentifier[?Yield, ?Await] BindingPattern[?Yield, ?Await] Note

This section is extended by Annex B.3.5.

14.7.5.1 Static Semantics: Early Errors

ForInOfStatement : for ( LeftHandSideExpression in Expression ) Statement for ( var ForBinding in Expression ) Statement for ( ForDeclaration in Expression ) Statement for ( LeftHandSideExpression of AssignmentExpression ) Statement for ( var ForBinding of AssignmentExpression ) Statement for ( ForDeclaration of AssignmentExpression ) Statement for await ( LeftHandSideExpression of AssignmentExpression ) Statement for await ( var ForBinding of AssignmentExpression ) Statement for await ( ForDeclaration of AssignmentExpression ) Statement Note

It is only necessary to apply this rule if the extension specified in B.3.1 is implemented.

ForInOfStatement : for ( LeftHandSideExpression in Expression ) Statement for ( LeftHandSideExpression of AssignmentExpression ) Statement for await ( LeftHandSideExpression of AssignmentExpression ) Statement ForInOfStatement : for ( ForDeclaration in Expression ) Statement for ( ForDeclaration of AssignmentExpression ) Statement for await ( ForDeclaration of AssignmentExpression ) Statement

14.7.5.2 Static Semantics: IsDestructuring

The syntax-directed operation IsDestructuring takes no arguments and returns a Boolean. It is defined piecewise over the following productions:

MemberExpression : PrimaryExpression
  1. If PrimaryExpression is either an ObjectLiteral or an ArrayLiteral, return true.
  2. Return false.
MemberExpression : MemberExpression [ Expression ] MemberExpression . IdentifierName MemberExpression TemplateLiteral SuperProperty MetaProperty new MemberExpression Arguments MemberExpression . PrivateIdentifier NewExpression : new NewExpression LeftHandSideExpression : CallExpression OptionalExpression
  1. Return false.
ForDeclaration : LetOrConst ForBinding
  1. Return IsDestructuring of ForBinding.
ForBinding : BindingIdentifier
  1. Return false.
ForBinding : BindingPattern
  1. Return true.
Note

This section is extended by Annex B.3.5.

14.7.5.3 Runtime Semantics: ForDeclarationBindingInitialization

The syntax-directed operation ForDeclarationBindingInitialization takes arguments value (an ECMAScript language value) and environment (an Environment Record or undefined) and returns either a normal completion containing unused or an abrupt completion.

Note

undefined is passed for environment to indicate that a PutValue operation should be used to assign the initialization value. This is the case for var statements and the formal parameter lists of some non-strict functions (see 10.2.11). In those cases a lexical binding is hoisted and preinitialized prior to evaluation of its initializer.

It is defined piecewise over the following productions:

ForDeclaration : LetOrConst ForBinding
  1. Return ? BindingInitialization of ForBinding with arguments value and environment.

14.7.5.4 Runtime Semantics: ForDeclarationBindingInstantiation

The syntax-directed operation ForDeclarationBindingInstantiation takes argument environment (a Declarative Environment Record) and returns unused. It is defined piecewise over the following productions:

ForDeclaration : LetOrConst ForBinding
  1. For each element name of the BoundNames of ForBinding, do
    1. If IsConstantDeclaration of LetOrConst is true, then
      1. Perform ! environment.CreateImmutableBinding(name, true).
    2. Else,
      1. Perform ! environment.CreateMutableBinding(name, false).
  2. Return unused.

14.7.5.5 Runtime Semantics: ForInOfLoopEvaluation

The syntax-directed operation ForInOfLoopEvaluation takes argument labelSet (a List of Strings) and returns either a normal completion containing an ECMAScript language value or an abrupt completion. It is defined piecewise over the following productions:

ForInOfStatement : for ( LeftHandSideExpression in Expression ) Statement
  1. Let keyResult be ? ForIn/OfHeadEvaluation(« », Expression, enumerate).
  2. Return ? ForIn/OfBodyEvaluation(LeftHandSideExpression, Statement, keyResult, enumerate, assignment, labelSet).
ForInOfStatement : for ( var ForBinding in Expression ) Statement
  1. Let keyResult be ? ForIn/OfHeadEvaluation(« », Expression, enumerate).
  2. Return ? ForIn/OfBodyEvaluation(ForBinding, Statement, keyResult, enumerate, var-binding, labelSet).
ForInOfStatement : for ( ForDeclaration in Expression ) Statement
  1. Let keyResult be ? ForIn/OfHeadEvaluation(BoundNames of ForDeclaration, Expression, enumerate).
  2. Return ? ForIn/OfBodyEvaluation(ForDeclaration, Statement, keyResult, enumerate, lexical-binding, labelSet).
ForInOfStatement : for ( LeftHandSideExpression of AssignmentExpression ) Statement
  1. Let keyResult be ? ForIn/OfHeadEvaluation(« », AssignmentExpression, iterate).
  2. Return ? ForIn/OfBodyEvaluation(LeftHandSideExpression, Statement, keyResult, iterate, assignment, labelSet).
ForInOfStatement : for ( var ForBinding of AssignmentExpression ) Statement
  1. Let keyResult be ? ForIn/OfHeadEvaluation(« », AssignmentExpression, iterate).
  2. Return ? ForIn/OfBodyEvaluation(ForBinding, Statement, keyResult, iterate, var-binding, labelSet).
ForInOfStatement : for ( ForDeclaration of AssignmentExpression ) Statement
  1. Let keyResult be ? ForIn/OfHeadEvaluation(BoundNames of ForDeclaration, AssignmentExpression, iterate).
  2. Return ? ForIn/OfBodyEvaluation(ForDeclaration, Statement, keyResult, iterate, lexical-binding, labelSet).
ForInOfStatement : for await ( LeftHandSideExpression of AssignmentExpression ) Statement
  1. Let keyResult be ? ForIn/OfHeadEvaluation(« », AssignmentExpression, async-iterate).
  2. Return ? ForIn/OfBodyEvaluation(LeftHandSideExpression, Statement, keyResult, iterate, assignment, labelSet, async).
ForInOfStatement : for await ( var ForBinding of AssignmentExpression ) Statement
  1. Let keyResult be ? ForIn/OfHeadEvaluation(« », AssignmentExpression, async-iterate).
  2. Return ? ForIn/OfBodyEvaluation(ForBinding, Statement, keyResult, iterate, var-binding, labelSet, async).
ForInOfStatement : for await ( ForDeclaration of AssignmentExpression ) Statement
  1. Let keyResult be ? ForIn/OfHeadEvaluation(BoundNames of ForDeclaration, AssignmentExpression, async-iterate).
  2. Return ? ForIn/OfBodyEvaluation(ForDeclaration, Statement, keyResult, iterate, lexical-binding, labelSet, async).
Note

This section is extended by Annex B.3.5.

14.7.5.6 ForIn/OfHeadEvaluation ( uninitializedBoundNames, expr, iterationKind )

The abstract operation ForIn/OfHeadEvaluation takes arguments uninitializedBoundNames (a List of Strings), expr (an Expression Parse Node or an AssignmentExpression Parse Node), and iterationKind (enumerate, iterate, or async-iterate) and returns either a normal completion containing an Iterator Record or an abrupt completion. It performs the following steps when called:

  1. Let oldEnv be the running execution context's LexicalEnvironment.
  2. If uninitializedBoundNames is not empty, then
    1. Assert: uninitializedBoundNames has no duplicate entries.
    2. Let newEnv be NewDeclarativeEnvironment(oldEnv).
    3. For each String name of uninitializedBoundNames, do
      1. Perform ! newEnv.CreateMutableBinding(name, false).
    4. Set the running execution context's LexicalEnvironment to newEnv.
  3. Let exprRef be Completion(Evaluation of expr).
  4. Set the running execution context's LexicalEnvironment to oldEnv.
  5. Let exprValue be ? GetValue(? exprRef).
  6. If iterationKind is enumerate, then
    1. If exprValue is either undefined or null, then
      1. Return Completion Record { [[Type]]: break, [[Value]]: empty, [[Target]]: empty }.
    2. Let obj be ! ToObject(exprValue).
    3. Let iterator be EnumerateObjectProperties(obj).
    4. Let nextMethod be ! GetV(iterator, "next").
    5. Return the Iterator Record { [[Iterator]]: iterator, [[NextMethod]]: nextMethod, [[Done]]: false }.
  7. Else,
    1. Assert: iterationKind is either iterate or async-iterate.
    2. If iterationKind is async-iterate, let iteratorKind be async.
    3. Else, let iteratorKind be sync.
    4. Return ? GetIterator(exprValue, iteratorKind).

14.7.5.7 ForIn/OfBodyEvaluation ( lhs, stmt, iteratorRecord, iterationKind, lhsKind, labelSet [ , iteratorKind ] )

The abstract operation ForIn/OfBodyEvaluation takes arguments lhs (a Parse Node), stmt (a Statement Parse Node), iteratorRecord (an Iterator Record), iterationKind (enumerate or iterate), lhsKind (assignment, var-binding, or lexical-binding), and labelSet (a List of Strings) and optional argument iteratorKind (sync or async) and returns either a normal completion containing an ECMAScript language value or an abrupt completion. It performs the following steps when called:

  1. If iteratorKind is not present, set iteratorKind to sync.
  2. Let oldEnv be the running execution context's LexicalEnvironment.
  3. Let V be undefined.
  4. Let destructuring be IsDestructuring of lhs.
  5. If destructuring is true and lhsKind is assignment, then
    1. Assert: lhs is a LeftHandSideExpression.
    2. Let assignmentPattern be the AssignmentPattern that is covered by lhs.
  6. Repeat,
    1. Let nextResult be ? Call(iteratorRecord.[[NextMethod]], iteratorRecord.[[Iterator]]).
    2. If iteratorKind is async, set nextResult to ? Await(nextResult).
    3. If nextResult is not an Object, throw a TypeError exception.
    4. Let done be ? IteratorComplete(nextResult).
    5. If done is true, return V.
    6. Let nextValue be ? IteratorValue(nextResult).
    7. If lhsKind is either assignment or var-binding, then
      1. If destructuring is true, then
        1. If lhsKind is assignment, then
          1. Let status be Completion(DestructuringAssignmentEvaluation of assignmentPattern with argument nextValue).
        2. Else,
          1. Assert: lhsKind is var-binding.
          2. Assert: lhs is a ForBinding.
          3. Let status be Completion(BindingInitialization of lhs with arguments nextValue and undefined).
      2. Else,
        1. Let lhsRef be Completion(Evaluation of lhs). (It may be evaluated repeatedly.)
        2. If lhsKind is assignment and the AssignmentTargetType of lhs is web-compat, throw a ReferenceError exception.
        3. If lhsRef is an abrupt completion, then
          1. Let status be lhsRef.
        4. Else,
          1. Let status be Completion(PutValue(lhsRef.[[Value]], nextValue)).
    8. Else,
      1. Assert: lhsKind is lexical-binding.
      2. Assert: lhs is a ForDeclaration.
      3. Let iterationEnv be NewDeclarativeEnvironment(oldEnv).
      4. Perform ForDeclarationBindingInstantiation of lhs with argument iterationEnv.
      5. Set the running execution context's LexicalEnvironment to iterationEnv.
      6. If destructuring is true, then
        1. Let status be Completion(ForDeclarationBindingInitialization of lhs with arguments nextValue and iterationEnv).
      7. Else,
        1. Assert: lhs binds a single name.
        2. Let lhsName be the sole element of the BoundNames of lhs.
        3. Let lhsRef be ! ResolveBinding(lhsName).
        4. Let status be Completion(InitializeReferencedBinding(lhsRef, nextValue)).
    9. If status is an abrupt completion, then
      1. Set the running execution context's LexicalEnvironment to oldEnv.
      2. If iteratorKind is async, return ? AsyncIteratorClose(iteratorRecord, status).
      3. If iterationKind is enumerate, then
        1. Return ? status.
      4. Else,
        1. Assert: iterationKind is iterate.
        2. Return ? IteratorClose(iteratorRecord, status).
    10. Let result be Completion(Evaluation of stmt).
    11. Set the running execution context's LexicalEnvironment to oldEnv.
    12. If LoopContinues(result, labelSet) is false, then
      1. If iterationKind is enumerate, then
        1. Return ? UpdateEmpty(result, V).
      2. Else,
        1. Assert: iterationKind is iterate.
        2. Set status to Completion(UpdateEmpty(result, V)).
        3. If iteratorKind is async, return ? AsyncIteratorClose(iteratorRecord, status).
        4. Return ? IteratorClose(iteratorRecord, status).
    13. If result.[[Value]] is not empty, set V to result.[[Value]].

14.7.5.8 Runtime Semantics: Evaluation

BindingIdentifier : Identifier yield await
  1. Let bindingId be the StringValue of BindingIdentifier.
  2. Return ? ResolveBinding(bindingId).

14.7.5.9 EnumerateObjectProperties ( O )

The abstract operation EnumerateObjectProperties takes argument O (an Object) and returns an iterator object. It performs the following steps when called:

  1. Return an iterator object whose next method iterates over all the String-valued keys of enumerable properties of O. The iterator object is never directly accessible to ECMAScript code. The mechanics and order of enumerating the properties is not specified but must conform to the rules specified below.

The iterator's throw and return methods are null and are never invoked. The iterator's next method processes object properties to determine whether the property key should be returned as an iterator value. Returned property keys do not include keys that are Symbols. Properties of the target object may be deleted during enumeration. A property that is deleted before it is processed by the iterator's next method is ignored. If new properties are added to the target object during enumeration, the newly added properties are not guaranteed to be processed in the active enumeration. A property name will be returned by the iterator's next method at most once in any enumeration.

Enumerating the properties of the target object includes enumerating properties of its prototype, and the prototype of the prototype, and so on, recursively; but a property of a prototype is not processed if it has the same name as a property that has already been processed by the iterator's next method. The values of [[Enumerable]] attributes are not considered when determining if a property of a prototype object has already been processed. The enumerable property names of prototype objects must be obtained by invoking EnumerateObjectProperties passing the prototype object as the argument. EnumerateObjectProperties must obtain the own property keys of the target object by calling its [[OwnPropertyKeys]] internal method. Property attributes of the target object must be obtained by calling its [[GetOwnProperty]] internal method.

In addition, if neither O nor any object in its prototype chain is a Proxy exotic object, TypedArray, module namespace exotic object, or implementation provided exotic object, then the iterator must behave as would the iterator given by CreateForInIterator(O) until one of the following occurs:

  • the value of the [[Prototype]] internal slot of O or an object in its prototype chain changes,
  • a property is removed from O or an object in its prototype chain,
  • a property is added to an object in O's prototype chain, or
  • the value of the [[Enumerable]] attribute of a property of O or an object in its prototype chain changes.
Note 1

ECMAScript implementations are not required to implement the algorithm in 14.7.5.10.2.1 directly. They may choose any implementation whose behaviour will not deviate from that algorithm unless one of the constraints in the previous paragraph is violated.

The following is an informative definition of an ECMAScript generator function that conforms to these rules:

function* EnumerateObjectProperties(obj) {
  const visited = new Set();
  for (const key of Reflect.ownKeys(obj)) {
    if (typeof key === "symbol") continue;
    const desc = Reflect.getOwnPropertyDescriptor(obj, key);
    if (desc) {
      visited.add(key);
      if (desc.enumerable) yield key;
    }
  }
  const proto = Reflect.getPrototypeOf(obj);
  if (proto === null) return;
  for (const protoKey of EnumerateObjectProperties(proto)) {
    if (!visited.has(protoKey)) yield protoKey;
  }
}
Note 2
The list of exotic objects for which implementations are not required to match CreateForInIterator was chosen because implementations historically differed in behaviour for those cases, and agreed in all others.

14.7.5.10 For-In Iterator Objects

A For-In Iterator is an object that represents a specific iteration over some specific object. For-In Iterator objects are never directly accessible to ECMAScript code; they exist solely to illustrate the behaviour of EnumerateObjectProperties.

14.7.5.10.1 CreateForInIterator ( object )

The abstract operation CreateForInIterator takes argument object (an Object) and returns a For-In Iterator. It is used to create a For-In Iterator object which iterates over the own and inherited enumerable string properties of object in a specific order. It performs the following steps when called:

  1. Let iterator be OrdinaryObjectCreate(%ForInIteratorPrototype%, « [[Object]], [[ObjectWasVisited]], [[VisitedKeys]], [[RemainingKeys]] »).
  2. Set iterator.[[Object]] to object.
  3. Set iterator.[[ObjectWasVisited]] to false.
  4. Set iterator.[[VisitedKeys]] to a new empty List.
  5. Set iterator.[[RemainingKeys]] to a new empty List.
  6. Return iterator.

14.7.5.10.2 The %ForInIteratorPrototype% Object

The %ForInIteratorPrototype% object:

14.7.5.10.2.1 %ForInIteratorPrototype%.next ( )

  1. Let O be the this value.
  2. Assert: O is an Object.
  3. Assert: O has all of the internal slots of a For-In Iterator instance (14.7.5.10.3).
  4. Let object be O.[[Object]].
  5. Repeat,
    1. If O.[[ObjectWasVisited]] is false, then
      1. Let keys be ? object.[[OwnPropertyKeys]]().
      2. For each element key of keys, do
        1. If key is a String, then
          1. Append key to O.[[RemainingKeys]].
      3. Set O.[[ObjectWasVisited]] to true.
    2. Repeat, while O.[[RemainingKeys]] is not empty,
      1. Let r be the first element of O.[[RemainingKeys]].
      2. Remove the first element from O.[[RemainingKeys]].
      3. If O.[[VisitedKeys]] does not contain r, then
        1. Let desc be ? object.[[GetOwnProperty]](r).
        2. If desc is not undefined, then
          1. Append r to O.[[VisitedKeys]].
          2. If desc.[[Enumerable]] is true, return CreateIteratorResultObject(r, false).
    3. Set object to ? object.[[GetPrototypeOf]]().
    4. Set O.[[Object]] to object.
    5. Set O.[[ObjectWasVisited]] to false.
    6. If object is null, return CreateIteratorResultObject(undefined, true).

14.7.5.10.3 Properties of For-In Iterator Instances

For-In Iterator instances are ordinary objects that inherit properties from the %ForInIteratorPrototype% intrinsic object. For-In Iterator instances are initially created with the internal slots listed in Table 38.

Table 38: Internal Slots of For-In Iterator Instances
Internal Slot Type Description
[[Object]] an Object The Object value whose properties are being iterated.
[[ObjectWasVisited]] a Boolean true if the iterator has invoked [[OwnPropertyKeys]] on [[Object]], false otherwise.
[[VisitedKeys]] a List of Strings The values that have been emitted by this iterator thus far.
[[RemainingKeys]] a List of Strings The values remaining to be emitted for the current object, before iterating the properties of its prototype (if its prototype is not null).

14.8 The continue Statement

Syntax

ContinueStatement[Yield, Await] : continue ; continue [no LineTerminator here] LabelIdentifier[?Yield, ?Await] ;

14.8.1 Static Semantics: Early Errors

ContinueStatement : continue ; continue LabelIdentifier ;
  • It is a Syntax Error if this ContinueStatement is not nested, directly or indirectly (but not crossing function or static initialization block boundaries), within an IterationStatement.

14.8.2 Runtime Semantics: Evaluation

ContinueStatement : continue ;
  1. Return Completion Record { [[Type]]: continue, [[Value]]: empty, [[Target]]: empty }.
ContinueStatement : continue LabelIdentifier ;
  1. Let label be the StringValue of LabelIdentifier.
  2. Return Completion Record { [[Type]]: continue, [[Value]]: empty, [[Target]]: label }.

14.9 The break Statement

Syntax

BreakStatement[Yield, Await] : break ; break [no LineTerminator here] LabelIdentifier[?Yield, ?Await] ;

14.9.1 Static Semantics: Early Errors

BreakStatement : break ;

14.9.2 Runtime Semantics: Evaluation

BreakStatement : break ;
  1. Return Completion Record { [[Type]]: break, [[Value]]: empty, [[Target]]: empty }.
BreakStatement : break LabelIdentifier ;
  1. Let label be the StringValue of LabelIdentifier.
  2. Return Completion Record { [[Type]]: break, [[Value]]: empty, [[Target]]: label }.

14.10 The return Statement

Syntax

ReturnStatement[Yield, Await] : return ; return [no LineTerminator here] Expression[+In, ?Yield, ?Await] ; Note

A return statement causes a function to cease execution and, in most cases, returns a value to the caller. If Expression is omitted, the return value is undefined. Otherwise, the return value is the value of Expression. A return statement may not actually return a value to the caller depending on surrounding context. For example, in a try block, a return statement's Completion Record may be replaced with another Completion Record during evaluation of the finally block.

14.10.1 Runtime Semantics: Evaluation

ReturnStatement : return ;
  1. Return ReturnCompletion(undefined).
ReturnStatement : return Expression ;
  1. Let exprRef be ? Evaluation of Expression.
  2. Let exprValue be ? GetValue(exprRef).
  3. If GetGeneratorKind() is async, set exprValue to ? Await(exprValue).
  4. Return ReturnCompletion(exprValue).

14.11 The with Statement

Note 1

Use of the Legacy with statement is discouraged in new ECMAScript code. Consider alternatives that are permitted in both strict mode code and non-strict code, such as destructuring assignment.

Syntax

WithStatement[Yield, Await, Return] : with ( Expression[+In, ?Yield, ?Await] ) Statement[?Yield, ?Await, ?Return] Note 2

The with statement adds an Object Environment Record for a computed object to the lexical environment of the running execution context. It then executes a statement using this augmented lexical environment. Finally, it restores the original lexical environment.

14.11.1 Static Semantics: Early Errors

WithStatement : with ( Expression ) Statement Note

It is only necessary to apply the second rule if the extension specified in B.3.1 is implemented.

14.11.2 Runtime Semantics: Evaluation

WithStatement : with ( Expression ) Statement
  1. Let val be ? Evaluation of Expression.
  2. Let obj be ? ToObject(? GetValue(val)).
  3. Let oldEnv be the running execution context's LexicalEnvironment.
  4. Let newEnv be NewObjectEnvironment(obj, true, oldEnv).
  5. Set the running execution context's LexicalEnvironment to newEnv.
  6. Let C be Completion(Evaluation of Statement).
  7. Set the running execution context's LexicalEnvironment to oldEnv.
  8. Return ? UpdateEmpty(C, undefined).
Note

No matter how control leaves the embedded Statement, whether normally or by some form of abrupt completion or exception, the LexicalEnvironment is always restored to its former state.

14.12 The switch Statement

Syntax

SwitchStatement[Yield, Await, Return] : switch ( Expression[+In, ?Yield, ?Await] ) CaseBlock[?Yield, ?Await, ?Return] CaseBlock[Yield, Await, Return] : { CaseClauses[?Yield, ?Await, ?Return]opt } { CaseClauses[?Yield, ?Await, ?Return]opt DefaultClause[?Yield, ?Await, ?Return] CaseClauses[?Yield, ?Await, ?Return]opt } CaseClauses[Yield, Await, Return] : CaseClause[?Yield, ?Await, ?Return] CaseClauses[?Yield, ?Await, ?Return] CaseClause[?Yield, ?Await, ?Return] CaseClause[Yield, Await, Return] : case Expression[+In, ?Yield, ?Await] : StatementList[?Yield, ?Await, ?Return]opt DefaultClause[Yield, Await, Return] : default : StatementList[?Yield, ?Await, ?Return]opt

14.12.1 Static Semantics: Early Errors

SwitchStatement : switch ( Expression ) CaseBlock

14.12.2 Runtime Semantics: CaseBlockEvaluation

The syntax-directed operation CaseBlockEvaluation takes argument input (an ECMAScript language value) and returns either a normal completion containing an ECMAScript language value or an abrupt completion. It is defined piecewise over the following productions:

CaseBlock : { }
  1. Return undefined.
CaseBlock : { CaseClauses }
  1. Let V be undefined.
  2. Let A be the List of CaseClause items in CaseClauses, in source text order.
  3. Let found be false.
  4. For each CaseClause C of A, do
    1. If found is false, then
      1. Set found to ? CaseClauseIsSelected(C, input).
    2. If found is true, then
      1. Let R be Completion(Evaluation of C).
      2. If R.[[Value]] is not empty, set V to R.[[Value]].
      3. If R is an abrupt completion, return ? UpdateEmpty(R, V).
  5. Return V.
CaseBlock : { CaseClausesopt DefaultClause CaseClausesopt }
  1. Let V be undefined.
  2. If the first CaseClauses is present, then
    1. Let A be the List of CaseClause items in the first CaseClauses, in source text order.
  3. Else,
    1. Let A be a new empty List.
  4. Let found be false.
  5. For each CaseClause C of A, do
    1. If found is false, then
      1. Set found to ? CaseClauseIsSelected(C, input).
    2. If found is true, then
      1. Let R be Completion(Evaluation of C).
      2. If R.[[Value]] is not empty, set V to R.[[Value]].
      3. If R is an abrupt completion, return ? UpdateEmpty(R, V).
  6. Let foundInB be false.
  7. If the second CaseClauses is present, then
    1. Let B be the List of CaseClause items in the second CaseClauses, in source text order.
  8. Else,
    1. Let B be a new empty List.
  9. If found is false, then
    1. For each CaseClause C of B, do
      1. If foundInB is false, then
        1. Set foundInB to ? CaseClauseIsSelected(C, input).
      2. If foundInB is true, then
        1. Let R be Completion(Evaluation of CaseClause C).
        2. If R.[[Value]] is not empty, set V to R.[[Value]].
        3. If R is an abrupt completion, return ? UpdateEmpty(R, V).
  10. If foundInB is true, return V.
  11. Let defaultR be Completion(Evaluation of DefaultClause).
  12. If defaultR.[[Value]] is not empty, set V to defaultR.[[Value]].
  13. If defaultR is an abrupt completion, return ? UpdateEmpty(defaultR, V).
  14. NOTE: The following is another complete iteration of the second CaseClauses.
  15. For each CaseClause C of B, do
    1. Let R be Completion(Evaluation of CaseClause C).
    2. If R.[[Value]] is not empty, set V to R.[[Value]].
    3. If R is an abrupt completion, return ? UpdateEmpty(R, V).
  16. Return V.

14.12.3 CaseClauseIsSelected ( C, input )

The abstract operation CaseClauseIsSelected takes arguments C (a CaseClause Parse Node) and input (an ECMAScript language value) and returns either a normal completion containing a Boolean or an abrupt completion. It determines whether C matches input. It performs the following steps when called:

  1. Assert: C is an instance of the production CaseClause : case Expression : StatementListopt .
  2. Let exprRef be ? Evaluation of the Expression of C.
  3. Let clauseSelector be ? GetValue(exprRef).
  4. Return IsStrictlyEqual(input, clauseSelector).
Note

This operation does not execute C's StatementList (if any). The CaseBlock algorithm uses its return value to determine which StatementList to start executing.

14.12.4 Runtime Semantics: Evaluation

SwitchStatement : switch ( Expression ) CaseBlock
  1. Let exprRef be ? Evaluation of Expression.
  2. Let switchValue be ? GetValue(exprRef).
  3. Let oldEnv be the running execution context's LexicalEnvironment.
  4. Let blockEnv be NewDeclarativeEnvironment(oldEnv).
  5. Perform BlockDeclarationInstantiation(CaseBlock, blockEnv).
  6. Set the running execution context's LexicalEnvironment to blockEnv.
  7. Let R be Completion(CaseBlockEvaluation of CaseBlock with argument switchValue).
  8. Set the running execution context's LexicalEnvironment to oldEnv.
  9. Return R.
Note

No matter how control leaves the SwitchStatement the LexicalEnvironment is always restored to its former state.

CaseClause : case Expression :
  1. Return empty.
CaseClause : case Expression : StatementList
  1. Return ? Evaluation of StatementList.
DefaultClause : default :
  1. Return empty.
DefaultClause : default : StatementList
  1. Return ? Evaluation of StatementList.

14.13 Labelled Statements

Syntax

LabelledStatement[Yield, Await, Return] : LabelIdentifier[?Yield, ?Await] : LabelledItem[?Yield, ?Await, ?Return] LabelledItem[Yield, Await, Return] : Statement[?Yield, ?Await, ?Return] FunctionDeclaration[?Yield, ?Await, ~Default] Note

A Statement may be prefixed by a label. Labelled statements are only used in conjunction with labelled break and continue statements. ECMAScript has no goto statement. A Statement can be part of a LabelledStatement, which itself can be part of a LabelledStatement, and so on. The labels introduced this way are collectively referred to as the “current label set” when describing the semantics of individual statements.

14.13.1 Static Semantics: Early Errors

LabelledItem : FunctionDeclaration
  • It is a Syntax Error if any source text is matched by this production.
Note

An alternative definition for this rule is provided in B.3.1.

14.13.2 Static Semantics: IsLabelledFunction ( stmt )

The abstract operation IsLabelledFunction takes argument stmt (a Statement Parse Node) and returns a Boolean. It performs the following steps when called:

  1. If stmt is not a LabelledStatement, return false.
  2. Let item be the LabelledItem of stmt.
  3. If item is LabelledItem : FunctionDeclaration , return true.
  4. Let subStmt be the Statement of item.
  5. Return IsLabelledFunction(subStmt).

14.13.3 Runtime Semantics: Evaluation

LabelledStatement : LabelIdentifier : LabelledItem
  1. Return ? LabelledEvaluation of this LabelledStatement with argument « ».

14.13.4 Runtime Semantics: LabelledEvaluation

The syntax-directed operation LabelledEvaluation takes argument labelSet (a List of Strings) and returns either a normal completion containing either an ECMAScript language value or empty, or an abrupt completion. It is defined piecewise over the following productions:

BreakableStatement : IterationStatement
  1. Let stmtResult be Completion(LoopEvaluation of IterationStatement with argument labelSet).
  2. If stmtResult is a break completion, then
    1. If stmtResult.[[Target]] is empty, then
      1. If stmtResult.[[Value]] is empty, set stmtResult to NormalCompletion(undefined).
      2. Else, set stmtResult to NormalCompletion(stmtResult.[[Value]]).
  3. Return ? stmtResult.
BreakableStatement : SwitchStatement
  1. Let stmtResult be Completion(Evaluation of SwitchStatement).
  2. If stmtResult is a break completion, then
    1. If stmtResult.[[Target]] is empty, then
      1. If stmtResult.[[Value]] is empty, set stmtResult to NormalCompletion(undefined).
      2. Else, set stmtResult to NormalCompletion(stmtResult.[[Value]]).
  3. Return ? stmtResult.
Note 1

A BreakableStatement is one that can be exited via an unlabelled BreakStatement.

LabelledStatement : LabelIdentifier : LabelledItem
  1. Let label be the StringValue of LabelIdentifier.
  2. Let newLabelSet be the list-concatenation of labelSet and « label ».
  3. Let stmtResult be Completion(LabelledEvaluation of LabelledItem with argument newLabelSet).
  4. If stmtResult is a break completion and stmtResult.[[Target]] is label, then
    1. Set stmtResult to NormalCompletion(stmtResult.[[Value]]).
  5. Return ? stmtResult.
LabelledItem : FunctionDeclaration
  1. Return ? Evaluation of FunctionDeclaration.
Statement : BlockStatement VariableStatement EmptyStatement ExpressionStatement IfStatement ContinueStatement BreakStatement ReturnStatement WithStatement ThrowStatement TryStatement DebuggerStatement
  1. Return ? Evaluation of Statement.
Note 2

The only two productions of Statement which have special semantics for LabelledEvaluation are BreakableStatement and LabelledStatement.

14.14 The throw Statement

Syntax

ThrowStatement[Yield, Await] : throw [no LineTerminator here] Expression[+In, ?Yield, ?Await] ;

14.14.1 Runtime Semantics: Evaluation

ThrowStatement : throw Expression ;
  1. Let exprRef be ? Evaluation of Expression.
  2. Let exprValue be ? GetValue(exprRef).
  3. Return ThrowCompletion(exprValue).

14.15 The try Statement

Syntax

TryStatement[Yield, Await, Return] : try Block[?Yield, ?Await, ?Return] Catch[?Yield, ?Await, ?Return] try Block[?Yield, ?Await, ?Return] Finally[?Yield, ?Await, ?Return] try Block[?Yield, ?Await, ?Return] Catch[?Yield, ?Await, ?Return] Finally[?Yield, ?Await, ?Return] Catch[Yield, Await, Return] : catch ( CatchParameter[?Yield, ?Await] ) Block[?Yield, ?Await, ?Return] catch Block[?Yield, ?Await, ?Return] Finally[Yield, Await, Return] : finally Block[?Yield, ?Await, ?Return] CatchParameter[Yield, Await] : BindingIdentifier[?Yield, ?Await] BindingPattern[?Yield, ?Await] Note

The try statement encloses a block of code in which an exceptional condition can occur, such as a runtime error or a throw statement. The catch clause provides the exception-handling code. When a catch clause catches an exception, its CatchParameter is bound to that exception.

14.15.1 Static Semantics: Early Errors

Catch : catch ( CatchParameter ) Block Note

An alternative static semantics for this production is given in B.3.4.

14.15.2 Runtime Semantics: CatchClauseEvaluation

The syntax-directed operation CatchClauseEvaluation takes argument thrownValue (an ECMAScript language value) and returns either a normal completion containing either an ECMAScript language value or empty, or an abrupt completion. It is defined piecewise over the following productions:

Catch : catch ( CatchParameter ) Block
  1. Let oldEnv be the running execution context's LexicalEnvironment.
  2. Let catchEnv be NewDeclarativeEnvironment(oldEnv).
  3. For each element argName of the BoundNames of CatchParameter, do
    1. Perform ! catchEnv.CreateMutableBinding(argName, false).
  4. Set the running execution context's LexicalEnvironment to catchEnv.
  5. Let status be Completion(BindingInitialization of CatchParameter with arguments thrownValue and catchEnv).
  6. If status is an abrupt completion, then
    1. Set the running execution context's LexicalEnvironment to oldEnv.
    2. Return ? status.
  7. Let B be Completion(Evaluation of Block).
  8. Set the running execution context's LexicalEnvironment to oldEnv.
  9. Return ? B.
Catch : catch Block
  1. Return ? Evaluation of Block.
Note

No matter how control leaves the Block the LexicalEnvironment is always restored to its former state.

14.15.3 Runtime Semantics: Evaluation

TryStatement : try Block Catch
  1. Let B be Completion(Evaluation of Block).
  2. If B is a throw completion, let C be Completion(CatchClauseEvaluation of Catch with argument B.[[Value]]).
  3. Else, let C be B.
  4. Return ? UpdateEmpty(C, undefined).
TryStatement : try Block Finally
  1. Let B be Completion(Evaluation of Block).
  2. Let F be Completion(Evaluation of Finally).
  3. If F is a normal completion, set F to B.
  4. Return ? UpdateEmpty(F, undefined).
TryStatement : try Block Catch Finally
  1. Let B be Completion(Evaluation of Block).
  2. If B is a throw completion, let C be Completion(CatchClauseEvaluation of Catch with argument B.[[Value]]).
  3. Else, let C be B.
  4. Let F be Completion(Evaluation of Finally).
  5. If F is a normal completion, set F to C.
  6. Return ? UpdateEmpty(F, undefined).

14.16 The debugger Statement

Syntax

DebuggerStatement : debugger ;

14.16.1 Runtime Semantics: Evaluation

Note

Evaluating a DebuggerStatement may allow an implementation to cause a breakpoint when run under a debugger. If a debugger is not present or active this statement has no observable effect.

DebuggerStatement : debugger ;
  1. If an implementation-defined debugging facility is available and enabled, then
    1. Perform an implementation-defined debugging action.
    2. Return a new implementation-defined Completion Record.
  2. Else,
    1. Return empty.

15 ECMAScript Language: Functions and Classes

Note

Various ECMAScript language elements cause the creation of ECMAScript function objects (10.2). Evaluation of such functions starts with the execution of their [[Call]] internal method (10.2.1).

15.1 Parameter Lists

Syntax

UniqueFormalParameters[Yield, Await] : FormalParameters[?Yield, ?Await] FormalParameters[Yield, Await] : [empty] FunctionRestParameter[?Yield, ?Await] FormalParameterList[?Yield, ?Await] FormalParameterList[?Yield, ?Await] , FormalParameterList[?Yield, ?Await] , FunctionRestParameter[?Yield, ?Await] FormalParameterList[Yield, Await] : FormalParameter[?Yield, ?Await] FormalParameterList[?Yield, ?Await] , FormalParameter[?Yield, ?Await] FunctionRestParameter[Yield, Await] : BindingRestElement[?Yield, ?Await] FormalParameter[Yield, Await] : BindingElement[?Yield, ?Await]

15.1.1 Static Semantics: Early Errors

UniqueFormalParameters : FormalParameters FormalParameters : FormalParameterList Note

Multiple occurrences of the same BindingIdentifier in a FormalParameterList is only allowed for functions which have simple parameter lists and which are not defined in strict mode code.

15.1.2 Static Semantics: ContainsExpression

The syntax-directed operation ContainsExpression takes no arguments and returns a Boolean. It is defined piecewise over the following productions:

ObjectBindingPattern : { } { BindingRestProperty }
  1. Return false.
ObjectBindingPattern : { BindingPropertyList , BindingRestProperty }
  1. Return ContainsExpression of BindingPropertyList.
ArrayBindingPattern : [ Elisionopt ]
  1. Return false.
ArrayBindingPattern : [ Elisionopt BindingRestElement ]
  1. Return ContainsExpression of BindingRestElement.
ArrayBindingPattern : [ BindingElementList , Elisionopt ]
  1. Return ContainsExpression of BindingElementList.
ArrayBindingPattern : [ BindingElementList , Elisionopt BindingRestElement ]
  1. Let has be ContainsExpression of BindingElementList.
  2. If has is true, return true.
  3. Return ContainsExpression of BindingRestElement.
BindingPropertyList : BindingPropertyList , BindingProperty
  1. Let has be ContainsExpression of BindingPropertyList.
  2. If has is true, return true.
  3. Return ContainsExpression of BindingProperty.
BindingElementList : BindingElementList , BindingElisionElement
  1. Let has be ContainsExpression of BindingElementList.
  2. If has is true, return true.
  3. Return ContainsExpression of BindingElisionElement.
BindingElisionElement : Elisionopt BindingElement
  1. Return ContainsExpression of BindingElement.
BindingProperty : PropertyName : BindingElement
  1. Let has be IsComputedPropertyKey of PropertyName.
  2. If has is true, return true.
  3. Return ContainsExpression of BindingElement.
BindingElement : BindingPattern Initializer
  1. Return true.
SingleNameBinding : BindingIdentifier
  1. Return false.
SingleNameBinding : BindingIdentifier Initializer
  1. Return true.
BindingRestElement : ... BindingIdentifier
  1. Return false.
BindingRestElement : ... BindingPattern
  1. Return ContainsExpression of BindingPattern.
FormalParameters : [empty]
  1. Return false.
FormalParameters : FormalParameterList , FunctionRestParameter
  1. If ContainsExpression of FormalParameterList is true, return true.
  2. Return ContainsExpression of FunctionRestParameter.
FormalParameterList : FormalParameterList , FormalParameter
  1. If ContainsExpression of FormalParameterList is true, return true.
  2. Return ContainsExpression of FormalParameter.
ArrowParameters : BindingIdentifier
  1. Return false.
ArrowParameters : CoverParenthesizedExpressionAndArrowParameterList
  1. Let formals be the ArrowFormalParameters that is covered by CoverParenthesizedExpressionAndArrowParameterList.
  2. Return ContainsExpression of formals.
AsyncArrowBindingIdentifier : BindingIdentifier
  1. Return false.

15.1.3 Static Semantics: IsSimpleParameterList

The syntax-directed operation IsSimpleParameterList takes no arguments and returns a Boolean. It is defined piecewise over the following productions:

BindingElement : BindingPattern
  1. Return false.
BindingElement : BindingPattern Initializer
  1. Return false.
SingleNameBinding : BindingIdentifier
  1. Return true.
SingleNameBinding : BindingIdentifier Initializer
  1. Return false.
FormalParameters : [empty]
  1. Return true.
FormalParameters : FunctionRestParameter
  1. Return false.
FormalParameters : FormalParameterList , FunctionRestParameter
  1. Return false.
FormalParameterList : FormalParameterList , FormalParameter
  1. If IsSimpleParameterList of FormalParameterList is false, return false.
  2. Return IsSimpleParameterList of FormalParameter.
FormalParameter : BindingElement
  1. Return IsSimpleParameterList of BindingElement.
ArrowParameters : BindingIdentifier
  1. Return true.
ArrowParameters : CoverParenthesizedExpressionAndArrowParameterList
  1. Let formals be the ArrowFormalParameters that is covered by CoverParenthesizedExpressionAndArrowParameterList.
  2. Return IsSimpleParameterList of formals.
AsyncArrowBindingIdentifier : BindingIdentifier
  1. Return true.
CoverCallExpressionAndAsyncArrowHead : MemberExpression Arguments
  1. Let head be the AsyncArrowHead that is covered by CoverCallExpressionAndAsyncArrowHead.
  2. Return IsSimpleParameterList of head.

15.1.4 Static Semantics: HasInitializer

The syntax-directed operation HasInitializer takes no arguments and returns a Boolean. It is defined piecewise over the following productions:

BindingElement : BindingPattern
  1. Return false.
BindingElement : BindingPattern Initializer
  1. Return true.
SingleNameBinding : BindingIdentifier
  1. Return false.
SingleNameBinding : BindingIdentifier Initializer
  1. Return true.
FormalParameterList : FormalParameterList , FormalParameter
  1. If HasInitializer of FormalParameterList is true, return true.
  2. Return HasInitializer of FormalParameter.

15.1.5 Static Semantics: ExpectedArgumentCount

The syntax-directed operation ExpectedArgumentCount takes no arguments and returns a non-negative integer. It is defined piecewise over the following productions:

FormalParameters : [empty] FunctionRestParameter
  1. Return 0.
FormalParameters : FormalParameterList , FunctionRestParameter
  1. Return the ExpectedArgumentCount of FormalParameterList.
Note

The ExpectedArgumentCount of a FormalParameterList is the number of FormalParameters to the left of either the rest parameter or the first FormalParameter with an Initializer. A FormalParameter without an initializer is allowed after the first parameter with an initializer but such parameters are considered to be optional with undefined as their default value.

FormalParameterList : FormalParameter
  1. If HasInitializer of FormalParameter is true, return 0.
  2. Return 1.
FormalParameterList : FormalParameterList , FormalParameter
  1. Let count be the ExpectedArgumentCount of FormalParameterList.
  2. If HasInitializer of FormalParameterList is true or HasInitializer of FormalParameter is true, return count.
  3. Return count + 1.
ArrowParameters : BindingIdentifier
  1. Return 1.
ArrowParameters : CoverParenthesizedExpressionAndArrowParameterList
  1. Let formals be the ArrowFormalParameters that is covered by CoverParenthesizedExpressionAndArrowParameterList.
  2. Return the ExpectedArgumentCount of formals.
PropertySetParameterList : FormalParameter
  1. If HasInitializer of FormalParameter is true, return 0.
  2. Return 1.
AsyncArrowBindingIdentifier : BindingIdentifier
  1. Return 1.

15.2 Function Definitions

Syntax

FunctionDeclaration[Yield, Await, Default] : function BindingIdentifier[?Yield, ?Await] ( FormalParameters[~Yield, ~Await] ) { FunctionBody[~Yield, ~Await] } [+Default] function ( FormalParameters[~Yield, ~Await] ) { FunctionBody[~Yield, ~Await] } FunctionExpression : function BindingIdentifier[~Yield, ~Await]opt ( FormalParameters[~Yield, ~Await] ) { FunctionBody[~Yield, ~Await] } FunctionBody[Yield, Await] : FunctionStatementList[?Yield, ?Await] FunctionStatementList[Yield, Await] : StatementList[?Yield, ?Await, +Return]opt

15.2.1 Static Semantics: Early Errors

FunctionDeclaration : function BindingIdentifier ( FormalParameters ) { FunctionBody } function ( FormalParameters ) { FunctionBody } FunctionExpression : function BindingIdentifieropt ( FormalParameters ) { FunctionBody } Note

The LexicallyDeclaredNames of a FunctionBody does not include identifiers bound using var or function declarations.

FunctionBody : FunctionStatementList

15.2.2 Static Semantics: FunctionBodyContainsUseStrict

The syntax-directed operation FunctionBodyContainsUseStrict takes no arguments and returns a Boolean. It is defined piecewise over the following productions:

FunctionBody : FunctionStatementList
  1. If the Directive Prologue of FunctionBody contains a Use Strict Directive, return true; otherwise return false.

15.2.3 Runtime Semantics: EvaluateFunctionBody

The syntax-directed operation EvaluateFunctionBody takes arguments functionObject (an ECMAScript function object) and argumentsList (a List of ECMAScript language values) and returns a return completion or a throw completion. It is defined piecewise over the following productions:

FunctionBody : FunctionStatementList
  1. Perform ? FunctionDeclarationInstantiation(functionObject, argumentsList).
  2. Perform ? Evaluation of FunctionStatementList.
  3. NOTE: If the previous step resulted in a normal completion, then evaluation finished by proceeding past the end of the FunctionStatementList.
  4. Return ReturnCompletion(undefined).

15.2.4 Runtime Semantics: InstantiateOrdinaryFunctionObject

The syntax-directed operation InstantiateOrdinaryFunctionObject takes arguments env (an Environment Record) and privateEnv (a PrivateEnvironment Record or null) and returns an ECMAScript function object. It is defined piecewise over the following productions:

FunctionDeclaration : function BindingIdentifier ( FormalParameters ) { FunctionBody }
  1. Let name be the StringValue of BindingIdentifier.
  2. Let sourceText be the source text matched by FunctionDeclaration.
  3. Let F be OrdinaryFunctionCreate(%Function.prototype%, sourceText, FormalParameters, FunctionBody, non-lexical-this, env, privateEnv).
  4. Perform SetFunctionName(F, name).
  5. Perform MakeConstructor(F).
  6. Return F.
FunctionDeclaration : function ( FormalParameters ) { FunctionBody }
  1. Let sourceText be the source text matched by FunctionDeclaration.
  2. Let F be OrdinaryFunctionCreate(%Function.prototype%, sourceText, FormalParameters, FunctionBody, non-lexical-this, env, privateEnv).
  3. Perform SetFunctionName(F, "default").
  4. Perform MakeConstructor(F).
  5. Return F.
Note

An anonymous FunctionDeclaration can only occur as part of an export default declaration, and its function code is therefore always strict mode code.

15.2.5 Runtime Semantics: InstantiateOrdinaryFunctionExpression

The syntax-directed operation InstantiateOrdinaryFunctionExpression takes optional argument name (a property key or a Private Name) and returns an ECMAScript function object. It is defined piecewise over the following productions:

FunctionExpression : function ( FormalParameters ) { FunctionBody }
  1. If name is not present, set name to "".
  2. Let env be the LexicalEnvironment of the running execution context.
  3. Let privateEnv be the running execution context's PrivateEnvironment.
  4. Let sourceText be the source text matched by FunctionExpression.
  5. Let closure be OrdinaryFunctionCreate(%Function.prototype%, sourceText, FormalParameters, FunctionBody, non-lexical-this, env, privateEnv).
  6. Perform SetFunctionName(closure, name).
  7. Perform MakeConstructor(closure).
  8. Return closure.
FunctionExpression : function BindingIdentifier ( FormalParameters ) { FunctionBody }
  1. Assert: name is not present.
  2. Set name to the StringValue of BindingIdentifier.
  3. Let outerEnv be the running execution context's LexicalEnvironment.
  4. Let funcEnv be NewDeclarativeEnvironment(outerEnv).
  5. Perform ! funcEnv.CreateImmutableBinding(name, false).
  6. Let privateEnv be the running execution context's PrivateEnvironment.
  7. Let sourceText be the source text matched by FunctionExpression.
  8. Let closure be OrdinaryFunctionCreate(%Function.prototype%, sourceText, FormalParameters, FunctionBody, non-lexical-this, funcEnv, privateEnv).
  9. Perform SetFunctionName(closure, name).
  10. Perform MakeConstructor(closure).
  11. Perform ! funcEnv.InitializeBinding(name, closure).
  12. Return closure.
Note

The BindingIdentifier in a FunctionExpression can be referenced from inside the FunctionExpression's FunctionBody to allow the function to call itself recursively. However, unlike in a FunctionDeclaration, the BindingIdentifier in a FunctionExpression cannot be referenced from and does not affect the scope enclosing the FunctionExpression.

15.2.6 Runtime Semantics: Evaluation

FunctionDeclaration : function BindingIdentifier ( FormalParameters ) { FunctionBody }
  1. Return empty.
Note 1

An alternative semantics is provided in B.3.2.

FunctionDeclaration : function ( FormalParameters ) { FunctionBody }
  1. Return empty.
FunctionExpression : function BindingIdentifieropt ( FormalParameters ) { FunctionBody }
  1. Return InstantiateOrdinaryFunctionExpression of FunctionExpression.
Note 2

A "prototype" property is automatically created for every function defined using a FunctionDeclaration or FunctionExpression, to allow for the possibility that the function will be used as a constructor.

FunctionStatementList : [empty]
  1. Return undefined.

15.3 Arrow Function Definitions

Syntax

ArrowFunction[In, Yield, Await] : ArrowParameters[?Yield, ?Await] [no LineTerminator here] => ConciseBody[?In] ArrowParameters[Yield, Await] : BindingIdentifier[?Yield, ?Await] CoverParenthesizedExpressionAndArrowParameterList[?Yield, ?Await] ConciseBody[In] : [lookahead ≠ {] ExpressionBody[?In, ~Await] { FunctionBody[~Yield, ~Await] } ExpressionBody[In, Await] : AssignmentExpression[?In, ~Yield, ?Await]

Supplemental Syntax

When processing an instance of the production
ArrowParameters[Yield, Await] : CoverParenthesizedExpressionAndArrowParameterList[?Yield, ?Await]
the interpretation of CoverParenthesizedExpressionAndArrowParameterList is refined using the following grammar:

ArrowFormalParameters[Yield, Await] : ( UniqueFormalParameters[?Yield, ?Await] )

15.3.1 Static Semantics: Early Errors

ArrowFunction : ArrowParameters => ConciseBody ArrowParameters : CoverParenthesizedExpressionAndArrowParameterList

15.3.2 Static Semantics: ConciseBodyContainsUseStrict

The syntax-directed operation ConciseBodyContainsUseStrict takes no arguments and returns a Boolean. It is defined piecewise over the following productions:

ConciseBody : ExpressionBody
  1. Return false.
ConciseBody : { FunctionBody }
  1. Return FunctionBodyContainsUseStrict of FunctionBody.

15.3.3 Runtime Semantics: EvaluateConciseBody

The syntax-directed operation EvaluateConciseBody takes arguments functionObject (an ECMAScript function object) and argumentsList (a List of ECMAScript language values) and returns a return completion or a throw completion. It is defined piecewise over the following productions:

ConciseBody : ExpressionBody
  1. Perform ? FunctionDeclarationInstantiation(functionObject, argumentsList).
  2. Return ? Evaluation of ExpressionBody.

15.3.4 Runtime Semantics: InstantiateArrowFunctionExpression

The syntax-directed operation InstantiateArrowFunctionExpression takes optional argument name (a property key or a Private Name) and returns an ECMAScript function object. It is defined piecewise over the following productions:

ArrowFunction : ArrowParameters => ConciseBody
  1. If name is not present, set name to "".
  2. Let env be the LexicalEnvironment of the running execution context.
  3. Let privateEnv be the running execution context's PrivateEnvironment.
  4. Let sourceText be the source text matched by ArrowFunction.
  5. Let closure be OrdinaryFunctionCreate(%Function.prototype%, sourceText, ArrowParameters, ConciseBody, lexical-this, env, privateEnv).
  6. Perform SetFunctionName(closure, name).
  7. Return closure.
Note

An ArrowFunction does not define local bindings for arguments, super, this, or new.target. Any reference to arguments, super, this, or new.target within an ArrowFunction must resolve to a binding in a lexically enclosing environment. Typically this will be the Function Environment of an immediately enclosing function. Even though an ArrowFunction may contain references to super, the function object created in step 5 is not made into a method by performing MakeMethod. An ArrowFunction that references super is always contained within a non-ArrowFunction and the necessary state to implement super is accessible via the env that is captured by the function object of the ArrowFunction.

15.3.5 Runtime Semantics: Evaluation

ArrowFunction : ArrowParameters => ConciseBody
  1. Return InstantiateArrowFunctionExpression of ArrowFunction.
ExpressionBody : AssignmentExpression
  1. Let exprRef be ? Evaluation of AssignmentExpression.
  2. Let exprValue be ? GetValue(exprRef).
  3. Return ReturnCompletion(exprValue).

15.4 Method Definitions

Syntax

MethodDefinition[Yield, Await] : ClassElementName[?Yield, ?Await] ( UniqueFormalParameters[~Yield, ~Await] ) { FunctionBody[~Yield, ~Await] } GeneratorMethod[?Yield, ?Await] AsyncMethod[?Yield, ?Await] AsyncGeneratorMethod[?Yield, ?Await] get ClassElementName[?Yield, ?Await] ( ) { FunctionBody[~Yield, ~Await] } set ClassElementName[?Yield, ?Await] ( PropertySetParameterList ) { FunctionBody[~Yield, ~Await] } PropertySetParameterList : FormalParameter[~Yield, ~Await]

15.4.1 Static Semantics: Early Errors

MethodDefinition : ClassElementName ( UniqueFormalParameters ) { FunctionBody } MethodDefinition : set ClassElementName ( PropertySetParameterList ) { FunctionBody }

15.4.2 Static Semantics: HasDirectSuper

The syntax-directed operation HasDirectSuper takes no arguments and returns a Boolean. It is defined piecewise over the following productions:

MethodDefinition : ClassElementName ( UniqueFormalParameters ) { FunctionBody }
  1. If UniqueFormalParameters Contains SuperCall is true, return true.
  2. Return FunctionBody Contains SuperCall.
MethodDefinition : get ClassElementName ( ) { FunctionBody }
  1. Return FunctionBody Contains SuperCall.
MethodDefinition : set ClassElementName ( PropertySetParameterList ) { FunctionBody }
  1. If PropertySetParameterList Contains SuperCall is true, return true.
  2. Return FunctionBody Contains SuperCall.
GeneratorMethod : * ClassElementName ( UniqueFormalParameters ) { GeneratorBody }
  1. If UniqueFormalParameters Contains SuperCall is true, return true.
  2. Return GeneratorBody Contains SuperCall.
AsyncGeneratorMethod : async * ClassElementName ( UniqueFormalParameters ) { AsyncGeneratorBody }
  1. If UniqueFormalParameters Contains SuperCall is true, return true.
  2. Return AsyncGeneratorBody Contains SuperCall.
AsyncMethod : async ClassElementName ( UniqueFormalParameters ) { AsyncFunctionBody }
  1. If UniqueFormalParameters Contains SuperCall is true, return true.
  2. Return AsyncFunctionBody Contains SuperCall.

15.4.3 Static Semantics: SpecialMethod

The syntax-directed operation SpecialMethod takes no arguments and returns a Boolean. It is defined piecewise over the following productions:

MethodDefinition : ClassElementName ( UniqueFormalParameters ) { FunctionBody }
  1. Return false.
MethodDefinition : GeneratorMethod AsyncMethod AsyncGeneratorMethod get ClassElementName ( ) { FunctionBody } set ClassElementName ( PropertySetParameterList ) { FunctionBody }
  1. Return true.

15.4.4 Runtime Semantics: DefineMethod

The syntax-directed operation DefineMethod takes argument object (an Object) and optional argument functionPrototype (an Object) and returns either a normal completion containing a Record with fields [[Key]] (a property key) and [[Closure]] (an ECMAScript function object) or an abrupt completion. It is defined piecewise over the following productions:

MethodDefinition : ClassElementName ( UniqueFormalParameters ) { FunctionBody }
  1. Let propKey be ? Evaluation of ClassElementName.
  2. Let env be the running execution context's LexicalEnvironment.
  3. Let privateEnv be the running execution context's PrivateEnvironment.
  4. If functionPrototype is present, then
    1. Let prototype be functionPrototype.
  5. Else,
    1. Let prototype be %Function.prototype%.
  6. Let sourceText be the source text matched by MethodDefinition.
  7. Let closure be OrdinaryFunctionCreate(prototype, sourceText, UniqueFormalParameters, FunctionBody, non-lexical-this, env, privateEnv).
  8. Perform MakeMethod(closure, object).
  9. Return the Record { [[Key]]: propKey, [[Closure]]: closure }.

15.4.5 Runtime Semantics: MethodDefinitionEvaluation

The syntax-directed operation MethodDefinitionEvaluation takes arguments object (an Object) and enumerable (a Boolean) and returns either a normal completion containing either a PrivateElement or unused, or an abrupt completion. It is defined piecewise over the following productions:

MethodDefinition : ClassElementName ( UniqueFormalParameters ) { FunctionBody }
  1. Let methodDef be ? DefineMethod of MethodDefinition with argument object.
  2. Perform SetFunctionName(methodDef.[[Closure]], methodDef.[[Key]]).
  3. Return ? DefineMethodProperty(object, methodDef.[[Key]], methodDef.[[Closure]], enumerable).
MethodDefinition : get ClassElementName ( ) { FunctionBody }
  1. Let propKey be ? Evaluation of ClassElementName.
  2. Let env be the running execution context's LexicalEnvironment.
  3. Let privateEnv be the running execution context's PrivateEnvironment.
  4. Let sourceText be the source text matched by MethodDefinition.
  5. Let formalParameterList be an instance of the production FormalParameters : [empty] .
  6. Let closure be OrdinaryFunctionCreate(%Function.prototype%, sourceText, formalParameterList, FunctionBody, non-lexical-this, env, privateEnv).
  7. Perform MakeMethod(closure, object).
  8. Perform SetFunctionName(closure, propKey, "get").
  9. If propKey is a Private Name, then
    1. Return PrivateElement { [[Key]]: propKey, [[Kind]]: accessor, [[Get]]: closure, [[Set]]: undefined }.
  10. Else,
    1. Let desc be the PropertyDescriptor { [[Get]]: closure, [[Enumerable]]: enumerable, [[Configurable]]: true }.
    2. Perform ? DefinePropertyOrThrow(object, propKey, desc).
    3. Return unused.
MethodDefinition : set ClassElementName ( PropertySetParameterList ) { FunctionBody }
  1. Let propKey be ? Evaluation of ClassElementName.
  2. Let env be the running execution context's LexicalEnvironment.
  3. Let privateEnv be the running execution context's PrivateEnvironment.
  4. Let sourceText be the source text matched by MethodDefinition.
  5. Let closure be OrdinaryFunctionCreate(%Function.prototype%, sourceText, PropertySetParameterList, FunctionBody, non-lexical-this, env, privateEnv).
  6. Perform MakeMethod(closure, object).
  7. Perform SetFunctionName(closure, propKey, "set").
  8. If propKey is a Private Name, then
    1. Return PrivateElement { [[Key]]: propKey, [[Kind]]: accessor, [[Get]]: undefined, [[Set]]: closure }.
  9. Else,
    1. Let desc be the PropertyDescriptor { [[Set]]: closure, [[Enumerable]]: enumerable, [[Configurable]]: true }.
    2. Perform ? DefinePropertyOrThrow(object, propKey, desc).
    3. Return unused.
GeneratorMethod : * ClassElementName ( UniqueFormalParameters ) { GeneratorBody }
  1. Let propKey be ? Evaluation of ClassElementName.
  2. Let env be the running execution context's LexicalEnvironment.
  3. Let privateEnv be the running execution context's PrivateEnvironment.
  4. Let sourceText be the source text matched by GeneratorMethod.
  5. Let closure be OrdinaryFunctionCreate(%GeneratorFunction.prototype%, sourceText, UniqueFormalParameters, GeneratorBody, non-lexical-this, env, privateEnv).
  6. Perform MakeMethod(closure, object).
  7. Perform SetFunctionName(closure, propKey).
  8. Let prototype be OrdinaryObjectCreate(%GeneratorPrototype%).
  9. Perform ! DefinePropertyOrThrow(closure, "prototype", PropertyDescriptor { [[Value]]: prototype, [[Writable]]: true, [[Enumerable]]: false, [[Configurable]]: false }).
  10. Return ? DefineMethodProperty(object, propKey, closure, enumerable).
AsyncGeneratorMethod : async * ClassElementName ( UniqueFormalParameters ) { AsyncGeneratorBody }
  1. Let propKey be ? Evaluation of ClassElementName.
  2. Let env be the running execution context's LexicalEnvironment.
  3. Let privateEnv be the running execution context's PrivateEnvironment.
  4. Let sourceText be the source text matched by AsyncGeneratorMethod.
  5. Let closure be OrdinaryFunctionCreate(%AsyncGeneratorFunction.prototype%, sourceText, UniqueFormalParameters, AsyncGeneratorBody, non-lexical-this, env, privateEnv).
  6. Perform MakeMethod(closure, object).
  7. Perform SetFunctionName(closure, propKey).
  8. Let prototype be OrdinaryObjectCreate(%AsyncGeneratorPrototype%).
  9. Perform ! DefinePropertyOrThrow(closure, "prototype", PropertyDescriptor { [[Value]]: prototype, [[Writable]]: true, [[Enumerable]]: false, [[Configurable]]: false }).
  10. Return ? DefineMethodProperty(object, propKey, closure, enumerable).
AsyncMethod : async ClassElementName ( UniqueFormalParameters ) { AsyncFunctionBody }
  1. Let propKey be ? Evaluation of ClassElementName.
  2. Let env be the LexicalEnvironment of the running execution context.
  3. Let privateEnv be the running execution context's PrivateEnvironment.
  4. Let sourceText be the source text matched by AsyncMethod.
  5. Let closure be OrdinaryFunctionCreate(%AsyncFunction.prototype%, sourceText, UniqueFormalParameters, AsyncFunctionBody, non-lexical-this, env, privateEnv).
  6. Perform MakeMethod(closure, object).
  7. Perform SetFunctionName(closure, propKey).
  8. Return ? DefineMethodProperty(object, propKey, closure, enumerable).

15.5 Generator Function Definitions

Syntax

GeneratorDeclaration[Yield, Await, Default] : function * BindingIdentifier[?Yield, ?Await] ( FormalParameters[+Yield, ~Await] ) { GeneratorBody } [+Default] function * ( FormalParameters[+Yield, ~Await] ) { GeneratorBody } GeneratorExpression : function * BindingIdentifier[+Yield, ~Await]opt ( FormalParameters[+Yield, ~Await] ) { GeneratorBody } GeneratorMethod[Yield, Await] : * ClassElementName[?Yield, ?Await] ( UniqueFormalParameters[+Yield, ~Await] ) { GeneratorBody } GeneratorBody : FunctionBody[+Yield, ~Await] YieldExpression[In, Await] : yield yield [no LineTerminator here] AssignmentExpression[?In, +Yield, ?Await] yield [no LineTerminator here] * AssignmentExpression[?In, +Yield, ?Await] Note 1

The syntactic context immediately following yield requires use of the InputElementRegExpOrTemplateTail lexical goal.

Note 2

YieldExpression cannot be used within the FormalParameters of a generator function because any expressions that are part of FormalParameters are evaluated before the resulting Generator is in a resumable state.

Note 3

Abstract operations relating to Generators are defined in 27.5.3.

15.5.1 Static Semantics: Early Errors

GeneratorMethod : * ClassElementName ( UniqueFormalParameters ) { GeneratorBody } GeneratorDeclaration : function * BindingIdentifier ( FormalParameters ) { GeneratorBody } function * ( FormalParameters ) { GeneratorBody } GeneratorExpression : function * BindingIdentifieropt ( FormalParameters ) { GeneratorBody }

15.5.2 Runtime Semantics: EvaluateGeneratorBody

The syntax-directed operation EvaluateGeneratorBody takes arguments functionObject (an ECMAScript function object) and argumentsList (a List of ECMAScript language values) and returns a throw completion or a return completion. It is defined piecewise over the following productions:

GeneratorBody : FunctionBody
  1. Perform ? FunctionDeclarationInstantiation(functionObject, argumentsList).
  2. Let G be ? OrdinaryCreateFromConstructor(functionObject, "%GeneratorPrototype%", « [[GeneratorState]], [[GeneratorContext]], [[GeneratorBrand]] »).
  3. Set G.[[GeneratorBrand]] to empty.
  4. Set G.[[GeneratorState]] to suspended-start.
  5. Perform GeneratorStart(G, FunctionBody).
  6. Return ReturnCompletion(G).

15.5.3 Runtime Semantics: InstantiateGeneratorFunctionObject

The syntax-directed operation InstantiateGeneratorFunctionObject takes arguments env (an Environment Record) and privateEnv (a PrivateEnvironment Record or null) and returns an ECMAScript function object. It is defined piecewise over the following productions:

GeneratorDeclaration : function * BindingIdentifier ( FormalParameters ) { GeneratorBody }
  1. Let name be the StringValue of BindingIdentifier.
  2. Let sourceText be the source text matched by GeneratorDeclaration.
  3. Let F be OrdinaryFunctionCreate(%GeneratorFunction.prototype%, sourceText, FormalParameters, GeneratorBody, non-lexical-this, env, privateEnv).
  4. Perform SetFunctionName(F, name).
  5. Let prototype be OrdinaryObjectCreate(%GeneratorPrototype%).
  6. Perform ! DefinePropertyOrThrow(F, "prototype", PropertyDescriptor { [[Value]]: prototype, [[Writable]]: true, [[Enumerable]]: false, [[Configurable]]: false }).
  7. Return F.
GeneratorDeclaration : function * ( FormalParameters ) { GeneratorBody }
  1. Let sourceText be the source text matched by GeneratorDeclaration.
  2. Let F be OrdinaryFunctionCreate(%GeneratorFunction.prototype%, sourceText, FormalParameters, GeneratorBody, non-lexical-this, env, privateEnv).
  3. Perform SetFunctionName(F, "default").
  4. Let prototype be OrdinaryObjectCreate(%GeneratorPrototype%).
  5. Perform ! DefinePropertyOrThrow(F, "prototype", PropertyDescriptor { [[Value]]: prototype, [[Writable]]: true, [[Enumerable]]: false, [[Configurable]]: false }).
  6. Return F.
Note

An anonymous GeneratorDeclaration can only occur as part of an export default declaration, and its function code is therefore always strict mode code.

15.5.4 Runtime Semantics: InstantiateGeneratorFunctionExpression

The syntax-directed operation InstantiateGeneratorFunctionExpression takes optional argument name (a property key or a Private Name) and returns an ECMAScript function object. It is defined piecewise over the following productions:

GeneratorExpression : function * ( FormalParameters ) { GeneratorBody }
  1. If name is not present, set name to "".
  2. Let env be the LexicalEnvironment of the running execution context.
  3. Let privateEnv be the running execution context's PrivateEnvironment.
  4. Let sourceText be the source text matched by GeneratorExpression.
  5. Let closure be OrdinaryFunctionCreate(%GeneratorFunction.prototype%, sourceText, FormalParameters, GeneratorBody, non-lexical-this, env, privateEnv).
  6. Perform SetFunctionName(closure, name).
  7. Let prototype be OrdinaryObjectCreate(%GeneratorPrototype%).
  8. Perform ! DefinePropertyOrThrow(closure, "prototype", PropertyDescriptor { [[Value]]: prototype, [[Writable]]: true, [[Enumerable]]: false, [[Configurable]]: false }).
  9. Return closure.
GeneratorExpression : function * BindingIdentifier ( FormalParameters ) { GeneratorBody }
  1. Assert: name is not present.
  2. Set name to the StringValue of BindingIdentifier.
  3. Let outerEnv be the running execution context's LexicalEnvironment.
  4. Let funcEnv be NewDeclarativeEnvironment(outerEnv).
  5. Perform ! funcEnv.CreateImmutableBinding(name, false).
  6. Let privateEnv be the running execution context's PrivateEnvironment.
  7. Let sourceText be the source text matched by GeneratorExpression.
  8. Let closure be OrdinaryFunctionCreate(%GeneratorFunction.prototype%, sourceText, FormalParameters, GeneratorBody, non-lexical-this, funcEnv, privateEnv).
  9. Perform SetFunctionName(closure, name).
  10. Let prototype be OrdinaryObjectCreate(%GeneratorPrototype%).
  11. Perform ! DefinePropertyOrThrow(closure, "prototype", PropertyDescriptor { [[Value]]: prototype, [[Writable]]: true, [[Enumerable]]: false, [[Configurable]]: false }).
  12. Perform ! funcEnv.InitializeBinding(name, closure).
  13. Return closure.
Note

The BindingIdentifier in a GeneratorExpression can be referenced from inside the GeneratorExpression's FunctionBody to allow the generator code to call itself recursively. However, unlike in a GeneratorDeclaration, the BindingIdentifier in a GeneratorExpression cannot be referenced from and does not affect the scope enclosing the GeneratorExpression.

15.5.5 Runtime Semantics: Evaluation

GeneratorExpression : function * BindingIdentifieropt ( FormalParameters ) { GeneratorBody }
  1. Return InstantiateGeneratorFunctionExpression of GeneratorExpression.
YieldExpression : yield
  1. Return ? Yield(undefined).
YieldExpression : yield AssignmentExpression
  1. Let exprRef be ? Evaluation of AssignmentExpression.
  2. Let value be ? GetValue(exprRef).
  3. Return ? Yield(value).
YieldExpression : yield * AssignmentExpression
  1. Let generatorKind be GetGeneratorKind().
  2. Assert: generatorKind is either sync or async.
  3. Let exprRef be ? Evaluation of AssignmentExpression.
  4. Let value be ? GetValue(exprRef).
  5. Let iteratorRecord be ? GetIterator(value, generatorKind).
  6. Let iterator be iteratorRecord.[[Iterator]].
  7. Let received be NormalCompletion(undefined).
  8. Repeat,
    1. If received is a normal completion, then
      1. Let innerResult be ? Call(iteratorRecord.[[NextMethod]], iteratorRecord.[[Iterator]], « received.[[Value]] »).
      2. If generatorKind is async, set innerResult to ? Await(innerResult).
      3. If innerResult is not an Object, throw a TypeError exception.
      4. Let done be ? IteratorComplete(innerResult).
      5. If done is true, then
        1. Return ? IteratorValue(innerResult).
      6. If generatorKind is async, set received to Completion(AsyncGeneratorYield(? IteratorValue(innerResult))).
      7. Else, set received to Completion(GeneratorYield(innerResult)).
    2. Else if received is a throw completion, then
      1. Let throw be ? GetMethod(iterator, "throw").
      2. If throw is not undefined, then
        1. Let innerResult be ? Call(throw, iterator, « received.[[Value]] »).
        2. If generatorKind is async, set innerResult to ? Await(innerResult).
        3. NOTE: Exceptions from the inner iterator throw method are propagated. Normal completions from an inner throw method are processed similarly to an inner next.
        4. If innerResult is not an Object, throw a TypeError exception.
        5. Let done be ? IteratorComplete(innerResult).
        6. If done is true, then
          1. Return ? IteratorValue(innerResult).
        7. If generatorKind is async, set received to Completion(AsyncGeneratorYield(? IteratorValue(innerResult))).
        8. Else, set received to Completion(GeneratorYield(innerResult)).
      3. Else,
        1. NOTE: If iterator does not have a throw method, this throw is going to terminate the yield* loop. But first we need to give iterator a chance to clean up.
        2. Let closeCompletion be NormalCompletion(empty).
        3. If generatorKind is async, perform ? AsyncIteratorClose(iteratorRecord, closeCompletion).
        4. Else, perform ? IteratorClose(iteratorRecord, closeCompletion).
        5. NOTE: The next step throws a TypeError to indicate that there was a yield* protocol violation: iterator does not have a throw method.
        6. Throw a TypeError exception.
    3. Else,
      1. Assert: received is a return completion.
      2. Let return be ? GetMethod(iterator, "return").
      3. If return is undefined, then
        1. Set value to received.[[Value]].
        2. If generatorKind is async, then
          1. Set value to ? Await(value).
        3. Return ReturnCompletion(value).
      4. Let innerReturnResult be ? Call(return, iterator, « received.[[Value]] »).
      5. If generatorKind is async, set innerReturnResult to ? Await(innerReturnResult).
      6. If innerReturnResult is not an Object, throw a TypeError exception.
      7. Let done be ? IteratorComplete(innerReturnResult).
      8. If done is true, then
        1. Set value to ? IteratorValue(innerReturnResult).
        2. Return ReturnCompletion(value).
      9. If generatorKind is async, set received to Completion(AsyncGeneratorYield(? IteratorValue(innerReturnResult))).
      10. Else, set received to Completion(GeneratorYield(innerReturnResult)).

15.6 Async Generator Function Definitions

Syntax

AsyncGeneratorDeclaration[Yield, Await, Default] : async [no LineTerminator here] function * BindingIdentifier[?Yield, ?Await] ( FormalParameters[+Yield, +Await] ) { AsyncGeneratorBody } [+Default] async [no LineTerminator here] function * ( FormalParameters[+Yield, +Await] ) { AsyncGeneratorBody } AsyncGeneratorExpression : async [no LineTerminator here] function * BindingIdentifier[+Yield, +Await]opt ( FormalParameters[+Yield, +Await] ) { AsyncGeneratorBody } AsyncGeneratorMethod[Yield, Await] : async [no LineTerminator here] * ClassElementName[?Yield, ?Await] ( UniqueFormalParameters[+Yield, +Await] ) { AsyncGeneratorBody } AsyncGeneratorBody : FunctionBody[+Yield, +Await] Note 1

YieldExpression and AwaitExpression cannot be used within the FormalParameters of an async generator function because any expressions that are part of FormalParameters are evaluated before the resulting AsyncGenerator is in a resumable state.

Note 2

Abstract operations relating to AsyncGenerators are defined in 27.6.3.

15.6.1 Static Semantics: Early Errors

AsyncGeneratorMethod : async * ClassElementName ( UniqueFormalParameters ) { AsyncGeneratorBody } AsyncGeneratorDeclaration : async function * BindingIdentifier ( FormalParameters ) { AsyncGeneratorBody } async function * ( FormalParameters ) { AsyncGeneratorBody } AsyncGeneratorExpression : async function * BindingIdentifieropt ( FormalParameters ) { AsyncGeneratorBody }

15.6.2 Runtime Semantics: EvaluateAsyncGeneratorBody

The syntax-directed operation EvaluateAsyncGeneratorBody takes arguments functionObject (an ECMAScript function object) and argumentsList (a List of ECMAScript language values) and returns a throw completion or a return completion. It is defined piecewise over the following productions:

AsyncGeneratorBody : FunctionBody
  1. Perform ? FunctionDeclarationInstantiation(functionObject, argumentsList).
  2. Let generator be ? OrdinaryCreateFromConstructor(functionObject, "%AsyncGeneratorPrototype%", « [[AsyncGeneratorState]], [[AsyncGeneratorContext]], [[AsyncGeneratorQueue]], [[GeneratorBrand]] »).
  3. Set generator.[[GeneratorBrand]] to empty.
  4. Set generator.[[AsyncGeneratorState]] to suspended-start.
  5. Perform AsyncGeneratorStart(generator, FunctionBody).
  6. Return ReturnCompletion(generator).

15.6.3 Runtime Semantics: InstantiateAsyncGeneratorFunctionObject

The syntax-directed operation InstantiateAsyncGeneratorFunctionObject takes arguments env (an Environment Record) and privateEnv (a PrivateEnvironment Record or null) and returns an ECMAScript function object. It is defined piecewise over the following productions:

AsyncGeneratorDeclaration : async function * BindingIdentifier ( FormalParameters ) { AsyncGeneratorBody }
  1. Let name be the StringValue of BindingIdentifier.
  2. Let sourceText be the source text matched by AsyncGeneratorDeclaration.
  3. Let F be OrdinaryFunctionCreate(%AsyncGeneratorFunction.prototype%, sourceText, FormalParameters, AsyncGeneratorBody, non-lexical-this, env, privateEnv).
  4. Perform SetFunctionName(F, name).
  5. Let prototype be OrdinaryObjectCreate(%AsyncGeneratorPrototype%).
  6. Perform ! DefinePropertyOrThrow(F, "prototype", PropertyDescriptor { [[Value]]: prototype, [[Writable]]: true, [[Enumerable]]: false, [[Configurable]]: false }).
  7. Return F.
AsyncGeneratorDeclaration : async function * ( FormalParameters ) { AsyncGeneratorBody }
  1. Let sourceText be the source text matched by AsyncGeneratorDeclaration.
  2. Let F be OrdinaryFunctionCreate(%AsyncGeneratorFunction.prototype%, sourceText, FormalParameters, AsyncGeneratorBody, non-lexical-this, env, privateEnv).
  3. Perform SetFunctionName(F, "default").
  4. Let prototype be OrdinaryObjectCreate(%AsyncGeneratorPrototype%).
  5. Perform ! DefinePropertyOrThrow(F, "prototype", PropertyDescriptor { [[Value]]: prototype, [[Writable]]: true, [[Enumerable]]: false, [[Configurable]]: false }).
  6. Return F.
Note

An anonymous AsyncGeneratorDeclaration can only occur as part of an export default declaration.

15.6.4 Runtime Semantics: InstantiateAsyncGeneratorFunctionExpression

The syntax-directed operation InstantiateAsyncGeneratorFunctionExpression takes optional argument name (a property key or a Private Name) and returns an ECMAScript function object. It is defined piecewise over the following productions:

AsyncGeneratorExpression : async function * ( FormalParameters ) { AsyncGeneratorBody }
  1. If name is not present, set name to "".
  2. Let env be the LexicalEnvironment of the running execution context.
  3. Let privateEnv be the running execution context's PrivateEnvironment.
  4. Let sourceText be the source text matched by AsyncGeneratorExpression.
  5. Let closure be OrdinaryFunctionCreate(%AsyncGeneratorFunction.prototype%, sourceText, FormalParameters, AsyncGeneratorBody, non-lexical-this, env, privateEnv).
  6. Perform SetFunctionName(closure, name).
  7. Let prototype be OrdinaryObjectCreate(%AsyncGeneratorPrototype%).
  8. Perform ! DefinePropertyOrThrow(closure, "prototype", PropertyDescriptor { [[Value]]: prototype, [[Writable]]: true, [[Enumerable]]: false, [[Configurable]]: false }).
  9. Return closure.
AsyncGeneratorExpression : async function * BindingIdentifier ( FormalParameters ) { AsyncGeneratorBody }
  1. Assert: name is not present.
  2. Set name to the StringValue of BindingIdentifier.
  3. Let outerEnv be the running execution context's LexicalEnvironment.
  4. Let funcEnv be NewDeclarativeEnvironment(outerEnv).
  5. Perform ! funcEnv.CreateImmutableBinding(name, false).
  6. Let privateEnv be the running execution context's PrivateEnvironment.
  7. Let sourceText be the source text matched by AsyncGeneratorExpression.
  8. Let closure be OrdinaryFunctionCreate(%AsyncGeneratorFunction.prototype%, sourceText, FormalParameters, AsyncGeneratorBody, non-lexical-this, funcEnv, privateEnv).
  9. Perform SetFunctionName(closure, name).
  10. Let prototype be OrdinaryObjectCreate(%AsyncGeneratorPrototype%).
  11. Perform ! DefinePropertyOrThrow(closure, "prototype", PropertyDescriptor { [[Value]]: prototype, [[Writable]]: true, [[Enumerable]]: false, [[Configurable]]: false }).
  12. Perform ! funcEnv.InitializeBinding(name, closure).
  13. Return closure.
Note

The BindingIdentifier in an AsyncGeneratorExpression can be referenced from inside the AsyncGeneratorExpression's AsyncGeneratorBody to allow the generator code to call itself recursively. However, unlike in an AsyncGeneratorDeclaration, the BindingIdentifier in an AsyncGeneratorExpression cannot be referenced from and does not affect the scope enclosing the AsyncGeneratorExpression.

15.6.5 Runtime Semantics: Evaluation

AsyncGeneratorExpression : async function * BindingIdentifieropt ( FormalParameters ) { AsyncGeneratorBody }
  1. Return InstantiateAsyncGeneratorFunctionExpression of AsyncGeneratorExpression.

15.7 Class Definitions

Syntax

ClassDeclaration[Yield, Await, Default] : class BindingIdentifier[?Yield, ?Await] ClassTail[?Yield, ?Await] [+Default] class ClassTail[?Yield, ?Await] ClassExpression[Yield, Await] : class BindingIdentifier[?Yield, ?Await]opt ClassTail[?Yield, ?Await] ClassTail[Yield, Await] : ClassHeritage[?Yield, ?Await]opt { ClassBody[?Yield, ?Await]opt } ClassHeritage[Yield, Await] : extends LeftHandSideExpression[?Yield, ?Await] ClassBody[Yield, Await] : ClassElementList[?Yield, ?Await] ClassElementList[Yield, Await] : ClassElement[?Yield, ?Await] ClassElementList[?Yield, ?Await] ClassElement[?Yield, ?Await] ClassElement[Yield, Await] : MethodDefinition[?Yield, ?Await] static MethodDefinition[?Yield, ?Await] FieldDefinition[?Yield, ?Await] ; static FieldDefinition[?Yield, ?Await] ; ClassStaticBlock ; FieldDefinition[Yield, Await] : ClassElementName[?Yield, ?Await] Initializer[+In, ?Yield, ?Await]opt ClassElementName[Yield, Await] : PropertyName[?Yield, ?Await] PrivateIdentifier ClassStaticBlock : static { ClassStaticBlockBody } ClassStaticBlockBody : ClassStaticBlockStatementList ClassStaticBlockStatementList : StatementList[~Yield, +Await, ~Return]opt Note

A class definition is always strict mode code.

15.7.1 Static Semantics: Early Errors

ClassTail : ClassHeritageopt { ClassBody } ClassBody : ClassElementList ClassElement : MethodDefinition ClassElement : static MethodDefinition ClassElement : FieldDefinition ; ClassElement : static FieldDefinition ; FieldDefinition : ClassElementName Initializeropt ClassElementName : PrivateIdentifier ClassStaticBlockBody : ClassStaticBlockStatementList

15.7.2 Static Semantics: ClassElementKind

The syntax-directed operation ClassElementKind takes no arguments and returns constructor-method, non-constructor-method, or empty. It is defined piecewise over the following productions:

ClassElement : MethodDefinition
  1. If the PropName of MethodDefinition is "constructor", return constructor-method.
  2. Return non-constructor-method.
ClassElement : static MethodDefinition FieldDefinition ; static FieldDefinition ;
  1. Return non-constructor-method.
ClassElement : ClassStaticBlock
  1. Return non-constructor-method.
ClassElement : ;
  1. Return empty.

15.7.3 Static Semantics: ConstructorMethod

The syntax-directed operation ConstructorMethod takes no arguments and returns a ClassElement Parse Node or empty. It is defined piecewise over the following productions:

ClassElementList : ClassElement
  1. If the ClassElementKind of ClassElement is constructor-method, return ClassElement.
  2. Return empty.
ClassElementList : ClassElementList ClassElement
  1. Let head be the ConstructorMethod of ClassElementList.
  2. If head is not empty, return head.
  3. If the ClassElementKind of ClassElement is constructor-method, return ClassElement.
  4. Return empty.
Note

Early Error rules ensure that there is only one method definition named "constructor" and that it is not an accessor property or generator definition.

15.7.4 Static Semantics: IsStatic

The syntax-directed operation IsStatic takes no arguments and returns a Boolean. It is defined piecewise over the following productions:

ClassElement : MethodDefinition
  1. Return false.
ClassElement : static MethodDefinition
  1. Return true.
ClassElement : FieldDefinition ;
  1. Return false.
ClassElement : static FieldDefinition ;
  1. Return true.
ClassElement : ClassStaticBlock
  1. Return true.
ClassElement : ;
  1. Return false.

15.7.5 Static Semantics: NonConstructorElements

The syntax-directed operation NonConstructorElements takes no arguments and returns a List of ClassElement Parse Nodes. It is defined piecewise over the following productions:

ClassElementList : ClassElement
  1. If the ClassElementKind of ClassElement is non-constructor-method, then
    1. Return « ClassElement ».
  2. Return a new empty List.
ClassElementList : ClassElementList ClassElement
  1. Let list be the NonConstructorElements of ClassElementList.
  2. If the ClassElementKind of ClassElement is non-constructor-method, then
    1. Append ClassElement to the end of list.
  3. Return list.

15.7.6 Static Semantics: PrototypePropertyNameList

The syntax-directed operation PrototypePropertyNameList takes no arguments and returns a List of property keys. It is defined piecewise over the following productions:

ClassElementList : ClassElement
  1. Let propName be the PropName of ClassElement.
  2. If propName is empty, return a new empty List.
  3. If IsStatic of ClassElement is true, return a new empty List.
  4. Return « propName ».
ClassElementList : ClassElementList ClassElement
  1. Let list be the PrototypePropertyNameList of ClassElementList.
  2. Let propName be the PropName of ClassElement.
  3. If propName is empty, return list.
  4. If IsStatic of ClassElement is true, return list.
  5. Return the list-concatenation of list and « propName ».

15.7.7 Static Semantics: AllPrivateIdentifiersValid

The syntax-directed operation AllPrivateIdentifiersValid takes argument names (a List of Strings) and returns a Boolean.

Every grammar production alternative in this specification which is not listed below implicitly has the following default definition of AllPrivateIdentifiersValid:

  1. For each child node child of this Parse Node, do
    1. If child is an instance of a nonterminal, then
      1. If AllPrivateIdentifiersValid of child with argument names is false, return false.
  2. Return true.
MemberExpression : MemberExpression . PrivateIdentifier
  1. If names contains the StringValue of PrivateIdentifier, then
    1. Return AllPrivateIdentifiersValid of MemberExpression with argument names.
  2. Return false.
CallExpression : CallExpression . PrivateIdentifier
  1. If names contains the StringValue of PrivateIdentifier, then
    1. Return AllPrivateIdentifiersValid of CallExpression with argument names.
  2. Return false.
OptionalChain : ?. PrivateIdentifier
  1. If names contains the StringValue of PrivateIdentifier, return true.
  2. Return false.
OptionalChain : OptionalChain . PrivateIdentifier
  1. If names contains the StringValue of PrivateIdentifier, then
    1. Return AllPrivateIdentifiersValid of OptionalChain with argument names.
  2. Return false.
ClassBody : ClassElementList
  1. Let newNames be the list-concatenation of names and the PrivateBoundIdentifiers of ClassBody.
  2. Return AllPrivateIdentifiersValid of ClassElementList with argument newNames.
RelationalExpression : PrivateIdentifier in ShiftExpression
  1. If names contains the StringValue of PrivateIdentifier, then
    1. Return AllPrivateIdentifiersValid of ShiftExpression with argument names.
  2. Return false.

15.7.8 Static Semantics: PrivateBoundIdentifiers

The syntax-directed operation PrivateBoundIdentifiers takes no arguments and returns a List of Strings. It is defined piecewise over the following productions:

FieldDefinition : ClassElementName Initializeropt
  1. Return the PrivateBoundIdentifiers of ClassElementName.
ClassElementName : PrivateIdentifier
  1. Return a List whose sole element is the StringValue of PrivateIdentifier.
ClassElementName : PropertyName ClassElement : ClassStaticBlock ;
  1. Return a new empty List.
ClassElementList : ClassElementList ClassElement
  1. Let names1 be the PrivateBoundIdentifiers of ClassElementList.
  2. Let names2 be the PrivateBoundIdentifiers of ClassElement.
  3. Return the list-concatenation of names1 and names2.
MethodDefinition : ClassElementName ( UniqueFormalParameters ) { FunctionBody } get ClassElementName ( ) { FunctionBody } set ClassElementName ( PropertySetParameterList ) { FunctionBody } GeneratorMethod : * ClassElementName ( UniqueFormalParameters ) { GeneratorBody } AsyncMethod : async ClassElementName ( UniqueFormalParameters ) { AsyncFunctionBody } AsyncGeneratorMethod : async * ClassElementName ( UniqueFormalParameters ) { AsyncGeneratorBody }
  1. Return the PrivateBoundIdentifiers of ClassElementName.

15.7.9 Static Semantics: ContainsArguments

The syntax-directed operation ContainsArguments takes no arguments and returns a Boolean.

Every grammar production alternative in this specification which is not listed below implicitly has the following default definition of ContainsArguments:

  1. For each child node child of this Parse Node, do
    1. If child is an instance of a nonterminal, then
      1. If ContainsArguments of child is true, return true.
  2. Return false.
IdentifierReference : Identifier
  1. If the StringValue of Identifier is "arguments", return true.
  2. Return false.
FunctionDeclaration : function BindingIdentifier ( FormalParameters ) { FunctionBody } function ( FormalParameters ) { FunctionBody } FunctionExpression : function BindingIdentifieropt ( FormalParameters ) { FunctionBody } GeneratorDeclaration : function * BindingIdentifier ( FormalParameters ) { GeneratorBody } function * ( FormalParameters ) { GeneratorBody } GeneratorExpression : function * BindingIdentifieropt ( FormalParameters ) { GeneratorBody } AsyncGeneratorDeclaration : async function * BindingIdentifier ( FormalParameters ) { AsyncGeneratorBody } async function * ( FormalParameters ) { AsyncGeneratorBody } AsyncGeneratorExpression : async function * BindingIdentifieropt ( FormalParameters ) { AsyncGeneratorBody } AsyncFunctionDeclaration : async function BindingIdentifier ( FormalParameters ) { AsyncFunctionBody } async function ( FormalParameters ) { AsyncFunctionBody } AsyncFunctionExpression : async function BindingIdentifieropt ( FormalParameters ) { AsyncFunctionBody }
  1. Return false.
MethodDefinition : ClassElementName ( UniqueFormalParameters ) { FunctionBody } get ClassElementName ( ) { FunctionBody } set ClassElementName ( PropertySetParameterList ) { FunctionBody } GeneratorMethod : * ClassElementName ( UniqueFormalParameters ) { GeneratorBody } AsyncGeneratorMethod : async * ClassElementName ( UniqueFormalParameters ) { AsyncGeneratorBody } AsyncMethod : async ClassElementName ( UniqueFormalParameters ) { AsyncFunctionBody }
  1. Return ContainsArguments of ClassElementName.

15.7.10 Runtime Semantics: ClassFieldDefinitionEvaluation

The syntax-directed operation ClassFieldDefinitionEvaluation takes argument homeObject (an Object) and returns either a normal completion containing a ClassFieldDefinition Record or an abrupt completion. It is defined piecewise over the following productions:

FieldDefinition : ClassElementName Initializeropt
  1. Let name be ? Evaluation of ClassElementName.
  2. If Initializer is present, then
    1. Let formalParameterList be an instance of the production FormalParameters : [empty] .
    2. Let env be the LexicalEnvironment of the running execution context.
    3. Let privateEnv be the running execution context's PrivateEnvironment.
    4. Let sourceText be the empty sequence of Unicode code points.
    5. Let initializer be OrdinaryFunctionCreate(%Function.prototype%, sourceText, formalParameterList, Initializer, non-lexical-this, env, privateEnv).
    6. Perform MakeMethod(initializer, homeObject).
    7. Set initializer.[[ClassFieldInitializerName]] to name.
  3. Else,
    1. Let initializer be empty.
  4. Return the ClassFieldDefinition Record { [[Name]]: name, [[Initializer]]: initializer }.
Note
The function created for initializer is never directly accessible to ECMAScript code.

15.7.11 Runtime Semantics: ClassStaticBlockDefinitionEvaluation

The syntax-directed operation ClassStaticBlockDefinitionEvaluation takes argument homeObject (an Object) and returns a ClassStaticBlockDefinition Record. It is defined piecewise over the following productions:

ClassStaticBlock : static { ClassStaticBlockBody }
  1. Let lex be the running execution context's LexicalEnvironment.
  2. Let privateEnv be the running execution context's PrivateEnvironment.
  3. Let sourceText be the empty sequence of Unicode code points.
  4. Let formalParameters be an instance of the production FormalParameters : [empty] .
  5. Let bodyFunction be OrdinaryFunctionCreate(%Function.prototype%, sourceText, formalParameters, ClassStaticBlockBody, non-lexical-this, lex, privateEnv).
  6. Perform MakeMethod(bodyFunction, homeObject).
  7. Return the ClassStaticBlockDefinition Record { [[BodyFunction]]: bodyFunction }.
Note
The function bodyFunction is never directly accessible to ECMAScript code.

15.7.12 Runtime Semantics: EvaluateClassStaticBlockBody

The syntax-directed operation EvaluateClassStaticBlockBody takes argument functionObject (an ECMAScript function object) and returns a return completion or a throw completion. It is defined piecewise over the following productions:

ClassStaticBlockBody : ClassStaticBlockStatementList
  1. Assert: functionObject is a synthetic function created by ClassStaticBlockDefinitionEvaluation step 5.
  2. Perform ! FunctionDeclarationInstantiation(functionObject, « »).
  3. Perform ? Evaluation of ClassStaticBlockStatementList.
  4. Return ReturnCompletion(undefined).

15.7.13 Runtime Semantics: ClassElementEvaluation

The syntax-directed operation ClassElementEvaluation takes argument object (an Object) and returns either a normal completion containing either a ClassFieldDefinition Record, a ClassStaticBlockDefinition Record, a PrivateElement, or unused, or an abrupt completion. It is defined piecewise over the following productions:

ClassElement : FieldDefinition ; static FieldDefinition ;
  1. Return ? ClassFieldDefinitionEvaluation of FieldDefinition with argument object.
ClassElement : MethodDefinition static MethodDefinition
  1. Return ? MethodDefinitionEvaluation of MethodDefinition with arguments object and false.
ClassElement : ClassStaticBlock
  1. Return the ClassStaticBlockDefinitionEvaluation of ClassStaticBlock with argument object.
ClassElement : ;
  1. Return unused.

15.7.14 Runtime Semantics: ClassDefinitionEvaluation

The syntax-directed operation ClassDefinitionEvaluation takes arguments classBinding (a String or undefined) and className (a property key or a Private Name) and returns either a normal completion containing a function object or an abrupt completion.

Note

For ease of specification, private methods and accessors are included alongside private fields in the [[PrivateElements]] slot of class instances. However, any given object has either all or none of the private methods and accessors defined by a given class. This feature has been designed so that implementations may choose to implement private methods and accessors using a strategy which does not require tracking each method or accessor individually.

For example, an implementation could directly associate instance private methods with their corresponding Private Name and track, for each object, which class constructors have run with that object as their this value. Looking up an instance private method on an object then consists of checking that the class constructor which defines the method has been used to initialize the object, then returning the method associated with the Private Name.

This differs from private fields: because field initializers can throw during class instantiation, an individual object may have some proper subset of the private fields of a given class, and so private fields must in general be tracked individually.

It is defined piecewise over the following productions:

ClassTail : ClassHeritageopt { ClassBodyopt }
  1. Let env be the LexicalEnvironment of the running execution context.
  2. Let classEnv be NewDeclarativeEnvironment(env).
  3. If classBinding is not undefined, then
    1. Perform ! classEnv.CreateImmutableBinding(classBinding, true).
  4. Let outerPrivateEnvironment be the running execution context's PrivateEnvironment.
  5. Let classPrivateEnvironment be NewPrivateEnvironment(outerPrivateEnvironment).
  6. If ClassBody is present, then
    1. For each String dn of the PrivateBoundIdentifiers of ClassBody, do
      1. If classPrivateEnvironment.[[Names]] contains a Private Name pn such that pn.[[Description]] is dn, then
        1. Assert: This is only possible for getter/setter pairs.
      2. Else,
        1. Let name be a new Private Name whose [[Description]] is dn.
        2. Append name to classPrivateEnvironment.[[Names]].
  7. If ClassHeritage is not present, then
    1. Let protoParent be %Object.prototype%.
    2. Let constructorParent be %Function.prototype%.
  8. Else,
    1. Set the running execution context's LexicalEnvironment to classEnv.
    2. NOTE: The running execution context's PrivateEnvironment is outerPrivateEnvironment when evaluating ClassHeritage.
    3. Let superclassRef be Completion(Evaluation of ClassHeritage).
    4. Set the running execution context's LexicalEnvironment to env.
    5. Let superclass be ? GetValue(? superclassRef).
    6. If superclass is null, then
      1. Let protoParent be null.
      2. Let constructorParent be %Function.prototype%.
    7. Else if IsConstructor(superclass) is false, then
      1. Throw a TypeError exception.
    8. Else,
      1. Let protoParent be ? Get(superclass, "prototype").
      2. If protoParent is not an Object and protoParent is not null, throw a TypeError exception.
      3. Let constructorParent be superclass.
  9. Let proto be OrdinaryObjectCreate(protoParent).
  10. If ClassBody is not present, let constructor be empty.
  11. Else, let constructor be the ConstructorMethod of ClassBody.
  12. Set the running execution context's LexicalEnvironment to classEnv.
  13. Set the running execution context's PrivateEnvironment to classPrivateEnvironment.
  14. If constructor is empty, then
    1. Let defaultConstructor be a new Abstract Closure with no parameters that captures nothing and performs the following steps when called:
      1. Let args be the List of arguments that was passed to this function by [[Call]] or [[Construct]].
      2. If NewTarget is undefined, throw a TypeError exception.
      3. Let F be the active function object.
      4. If F.[[ConstructorKind]] is derived, then
        1. NOTE: This branch behaves similarly to constructor(...args) { super(...args); }. The most notable distinction is that while the aforementioned ECMAScript source text observably calls the %Symbol.iterator% method on %Array.prototype%, this function does not.
        2. Let func be ! F.[[GetPrototypeOf]]().
        3. If IsConstructor(func) is false, throw a TypeError exception.
        4. Let result be ? Construct(func, args, NewTarget).
      5. Else,
        1. NOTE: This branch behaves similarly to constructor() {}.
        2. Let result be ? OrdinaryCreateFromConstructor(NewTarget, "%Object.prototype%").
      6. Perform ? InitializeInstanceElements(result, F).
      7. Return NormalCompletion(result).
    2. Let F be CreateBuiltinFunction(defaultConstructor, 0, className, « [[ConstructorKind]], [[SourceText]] », the current Realm Record, constructorParent).
  15. Else,
    1. Let constructorInfo be ! DefineMethod of constructor with arguments proto and constructorParent.
    2. Let F be constructorInfo.[[Closure]].
    3. Perform MakeClassConstructor(F).
    4. Perform SetFunctionName(F, className).
  16. Perform MakeConstructor(F, false, proto).
  17. If ClassHeritage is present, set F.[[ConstructorKind]] to derived.
  18. Perform ! DefineMethodProperty(proto, "constructor", F, false).
  19. If ClassBody is not present, let elements be a new empty List.
  20. Else, let elements be the NonConstructorElements of ClassBody.
  21. Let instancePrivateMethods be a new empty List.
  22. Let staticPrivateMethods be a new empty List.
  23. Let instanceFields be a new empty List.
  24. Let staticElements be a new empty List.
  25. For each ClassElement e of elements, do
    1. If IsStatic of e is false, then
      1. Let element be Completion(ClassElementEvaluation of e with argument proto).
    2. Else,
      1. Let element be Completion(ClassElementEvaluation of e with argument F).
    3. If element is an abrupt completion, then
      1. Set the running execution context's LexicalEnvironment to env.
      2. Set the running execution context's PrivateEnvironment to outerPrivateEnvironment.
      3. Return ? element.
    4. Set element to ! element.
    5. If element is a PrivateElement, then
      1. Assert: element.[[Kind]] is either method or accessor.
      2. If IsStatic of e is false, let container be instancePrivateMethods.
      3. Else, let container be staticPrivateMethods.
      4. If container contains a PrivateElement pe such that pe.[[Key]] is element.[[Key]], then
        1. Assert: element.[[Kind]] and pe.[[Kind]] are both accessor.
        2. If element.[[Get]] is undefined, then
          1. Let combined be PrivateElement { [[Key]]: element.[[Key]], [[Kind]]: accessor, [[Get]]: pe.[[Get]], [[Set]]: element.[[Set]] }.
        3. Else,
          1. Let combined be PrivateElement { [[Key]]: element.[[Key]], [[Kind]]: accessor, [[Get]]: element.[[Get]], [[Set]]: pe.[[Set]] }.
        4. Replace pe in container with combined.
      5. Else,
        1. Append element to container.
    6. Else if element is a ClassFieldDefinition Record, then
      1. If IsStatic of e is false, append element to instanceFields.
      2. Else, append element to staticElements.
    7. Else if element is a ClassStaticBlockDefinition Record, then
      1. Append element to staticElements.
  26. Set the running execution context's LexicalEnvironment to env.
  27. If classBinding is not undefined, then
    1. Perform ! classEnv.InitializeBinding(classBinding, F).
  28. Set F.[[PrivateMethods]] to instancePrivateMethods.
  29. Set F.[[Fields]] to instanceFields.
  30. For each PrivateElement method of staticPrivateMethods, do
    1. Perform ! PrivateMethodOrAccessorAdd(F, method).
  31. For each element elementRecord of staticElements, do
    1. If elementRecord is a ClassFieldDefinition Record, then
      1. Let result be Completion(DefineField(F, elementRecord)).
    2. Else,
      1. Assert: elementRecord is a ClassStaticBlockDefinition Record.
      2. Let result be Completion(Call(elementRecord.[[BodyFunction]], F)).
    3. If result is an abrupt completion, then
      1. Set the running execution context's PrivateEnvironment to outerPrivateEnvironment.
      2. Return ? result.
  32. Set the running execution context's PrivateEnvironment to outerPrivateEnvironment.
  33. Return F.

15.7.15 Runtime Semantics: BindingClassDeclarationEvaluation

The syntax-directed operation BindingClassDeclarationEvaluation takes no arguments and returns either a normal completion containing a function object or an abrupt completion. It is defined piecewise over the following productions:

ClassDeclaration : class BindingIdentifier ClassTail
  1. Let className be the StringValue of BindingIdentifier.
  2. Let value be ? ClassDefinitionEvaluation of ClassTail with arguments className and className.
  3. Set value.[[SourceText]] to the source text matched by ClassDeclaration.
  4. Let env be the running execution context's LexicalEnvironment.
  5. Perform ? InitializeBoundName(className, value, env).
  6. Return value.
ClassDeclaration : class ClassTail
  1. Let value be ? ClassDefinitionEvaluation of ClassTail with arguments undefined and "default".
  2. Set value.[[SourceText]] to the source text matched by ClassDeclaration.
  3. Return value.
Note

ClassDeclaration : class ClassTail only occurs as part of an ExportDeclaration and establishing its binding is handled as part of the evaluation action for that production. See 16.2.3.7.

15.7.16 Runtime Semantics: Evaluation

ClassDeclaration : class BindingIdentifier ClassTail
  1. Perform ? BindingClassDeclarationEvaluation of this ClassDeclaration.
  2. Return empty.
Note

ClassDeclaration : class ClassTail only occurs as part of an ExportDeclaration and is never directly evaluated.

ClassExpression : class ClassTail
  1. Let value be ? ClassDefinitionEvaluation of ClassTail with arguments undefined and "".
  2. Set value.[[SourceText]] to the source text matched by ClassExpression.
  3. Return value.
ClassExpression : class BindingIdentifier ClassTail
  1. Let className be the StringValue of BindingIdentifier.
  2. Let value be ? ClassDefinitionEvaluation of ClassTail with arguments className and className.
  3. Set value.[[SourceText]] to the source text matched by ClassExpression.
  4. Return value.
ClassElementName : PrivateIdentifier
  1. Let privateIdentifier be the StringValue of PrivateIdentifier.
  2. Let privateEnvRec be the running execution context's PrivateEnvironment.
  3. Let names be privateEnvRec.[[Names]].
  4. Assert: Exactly one element of names is a Private Name whose [[Description]] is privateIdentifier.
  5. Let privateName be the Private Name in names whose [[Description]] is privateIdentifier.
  6. Return privateName.
ClassStaticBlockStatementList : [empty]
  1. Return undefined.

15.8 Async Function Definitions

Syntax

AsyncFunctionDeclaration[Yield, Await, Default] : async [no LineTerminator here] function BindingIdentifier[?Yield, ?Await] ( FormalParameters[~Yield, +Await] ) { AsyncFunctionBody } [+Default] async [no LineTerminator here] function ( FormalParameters[~Yield, +Await] ) { AsyncFunctionBody } AsyncFunctionExpression : async [no LineTerminator here] function BindingIdentifier[~Yield, +Await]opt ( FormalParameters[~Yield, +Await] ) { AsyncFunctionBody } AsyncMethod[Yield, Await] : async [no LineTerminator here] ClassElementName[?Yield, ?Await] ( UniqueFormalParameters[~Yield, +Await] ) { AsyncFunctionBody } AsyncFunctionBody : FunctionBody[~Yield, +Await] AwaitExpression[Yield] : await UnaryExpression[?Yield, +Await] Note 1

await is parsed as a keyword of an AwaitExpression when the [Await] parameter is present. The [Await] parameter is present in the top level of the following contexts, although the parameter may be absent in some contexts depending on the nonterminals, such as FunctionBody:

When Script is the syntactic goal symbol, await may be parsed as an identifier when the [Await] parameter is absent. This includes the following contexts:

Note 2

Unlike YieldExpression, it is a Syntax Error to omit the operand of an AwaitExpression. You must await something.

15.8.1 Static Semantics: Early Errors

AsyncMethod : async ClassElementName ( UniqueFormalParameters ) { AsyncFunctionBody } AsyncFunctionDeclaration : async function BindingIdentifier ( FormalParameters ) { AsyncFunctionBody } async function ( FormalParameters ) { AsyncFunctionBody } AsyncFunctionExpression : async function BindingIdentifieropt ( FormalParameters ) { AsyncFunctionBody }

15.8.2 Runtime Semantics: InstantiateAsyncFunctionObject

The syntax-directed operation InstantiateAsyncFunctionObject takes arguments env (an Environment Record) and privateEnv (a PrivateEnvironment Record or null) and returns an ECMAScript function object. It is defined piecewise over the following productions:

AsyncFunctionDeclaration : async function BindingIdentifier ( FormalParameters ) { AsyncFunctionBody }
  1. Let name be the StringValue of BindingIdentifier.
  2. Let sourceText be the source text matched by AsyncFunctionDeclaration.
  3. Let F be OrdinaryFunctionCreate(%AsyncFunction.prototype%, sourceText, FormalParameters, AsyncFunctionBody, non-lexical-this, env, privateEnv).
  4. Perform SetFunctionName(F, name).
  5. Return F.
AsyncFunctionDeclaration : async function ( FormalParameters ) { AsyncFunctionBody }
  1. Let sourceText be the source text matched by AsyncFunctionDeclaration.
  2. Let F be OrdinaryFunctionCreate(%AsyncFunction.prototype%, sourceText, FormalParameters, AsyncFunctionBody, non-lexical-this, env, privateEnv).
  3. Perform SetFunctionName(F, "default").
  4. Return F.

15.8.3 Runtime Semantics: InstantiateAsyncFunctionExpression

The syntax-directed operation InstantiateAsyncFunctionExpression takes optional argument name (a property key or a Private Name) and returns an ECMAScript function object. It is defined piecewise over the following productions:

AsyncFunctionExpression : async function ( FormalParameters ) { AsyncFunctionBody }
  1. If name is not present, set name to "".
  2. Let env be the LexicalEnvironment of the running execution context.
  3. Let privateEnv be the running execution context's PrivateEnvironment.
  4. Let sourceText be the source text matched by AsyncFunctionExpression.
  5. Let closure be OrdinaryFunctionCreate(%AsyncFunction.prototype%, sourceText, FormalParameters, AsyncFunctionBody, non-lexical-this, env, privateEnv).
  6. Perform SetFunctionName(closure, name).
  7. Return closure.
AsyncFunctionExpression : async function BindingIdentifier ( FormalParameters ) { AsyncFunctionBody }
  1. Assert: name is not present.
  2. Set name to the StringValue of BindingIdentifier.
  3. Let outerEnv be the LexicalEnvironment of the running execution context.
  4. Let funcEnv be NewDeclarativeEnvironment(outerEnv).
  5. Perform ! funcEnv.CreateImmutableBinding(name, false).
  6. Let privateEnv be the running execution context's PrivateEnvironment.
  7. Let sourceText be the source text matched by AsyncFunctionExpression.
  8. Let closure be OrdinaryFunctionCreate(%AsyncFunction.prototype%, sourceText, FormalParameters, AsyncFunctionBody, non-lexical-this, funcEnv, privateEnv).
  9. Perform SetFunctionName(closure, name).
  10. Perform ! funcEnv.InitializeBinding(name, closure).
  11. Return closure.
Note

The BindingIdentifier in an AsyncFunctionExpression can be referenced from inside the AsyncFunctionExpression's AsyncFunctionBody to allow the function to call itself recursively. However, unlike in a FunctionDeclaration, the BindingIdentifier in a AsyncFunctionExpression cannot be referenced from and does not affect the scope enclosing the AsyncFunctionExpression.

15.8.4 Runtime Semantics: EvaluateAsyncFunctionBody

The syntax-directed operation EvaluateAsyncFunctionBody takes arguments functionObject (an ECMAScript function object) and argumentsList (a List of ECMAScript language values) and returns a return completion. It is defined piecewise over the following productions:

AsyncFunctionBody : FunctionBody
  1. Let promiseCapability be ! NewPromiseCapability(%Promise%).
  2. Let completion be Completion(FunctionDeclarationInstantiation(functionObject, argumentsList)).
  3. If completion is an abrupt completion, then
    1. Perform ! Call(promiseCapability.[[Reject]], undefined, « completion.[[Value]] »).
  4. Else,
    1. Perform AsyncFunctionStart(promiseCapability, FunctionBody).
  5. Return ReturnCompletion(promiseCapability.[[Promise]]).

15.8.5 Runtime Semantics: Evaluation

AsyncFunctionExpression : async function BindingIdentifieropt ( FormalParameters ) { AsyncFunctionBody }
  1. Return InstantiateAsyncFunctionExpression of AsyncFunctionExpression.
AwaitExpression : await UnaryExpression
  1. Let exprRef be ? Evaluation of UnaryExpression.
  2. Let value be ? GetValue(exprRef).
  3. Return ? Await(value).

15.9 Async Arrow Function Definitions

Syntax

AsyncArrowFunction[In, Yield, Await] : async [no LineTerminator here] AsyncArrowBindingIdentifier[?Yield] [no LineTerminator here] => AsyncConciseBody[?In] CoverCallExpressionAndAsyncArrowHead[?Yield, ?Await] [no LineTerminator here] => AsyncConciseBody[?In] AsyncConciseBody[In] : [lookahead ≠ {] ExpressionBody[?In, +Await] { AsyncFunctionBody } AsyncArrowBindingIdentifier[Yield] : BindingIdentifier[?Yield, +Await] CoverCallExpressionAndAsyncArrowHead[Yield, Await] : MemberExpression[?Yield, ?Await] Arguments[?Yield, ?Await]

Supplemental Syntax

When processing an instance of the production
AsyncArrowFunction : CoverCallExpressionAndAsyncArrowHead => AsyncConciseBody
the interpretation of CoverCallExpressionAndAsyncArrowHead is refined using the following grammar:

AsyncArrowHead : async [no LineTerminator here] ArrowFormalParameters[~Yield, +Await]

15.9.1 Static Semantics: Early Errors

AsyncArrowFunction : async AsyncArrowBindingIdentifier => AsyncConciseBody AsyncArrowFunction : CoverCallExpressionAndAsyncArrowHead => AsyncConciseBody

15.9.2 Static Semantics: AsyncConciseBodyContainsUseStrict

The syntax-directed operation AsyncConciseBodyContainsUseStrict takes no arguments and returns a Boolean. It is defined piecewise over the following productions:

AsyncConciseBody : ExpressionBody
  1. Return false.
AsyncConciseBody : { AsyncFunctionBody }
  1. Return FunctionBodyContainsUseStrict of AsyncFunctionBody.

15.9.3 Runtime Semantics: EvaluateAsyncConciseBody

The syntax-directed operation EvaluateAsyncConciseBody takes arguments functionObject (an ECMAScript function object) and argumentsList (a List of ECMAScript language values) and returns a return completion. It is defined piecewise over the following productions:

AsyncConciseBody : ExpressionBody
  1. Let promiseCapability be ! NewPromiseCapability(%Promise%).
  2. Let completion be Completion(FunctionDeclarationInstantiation(functionObject, argumentsList)).
  3. If completion is an abrupt completion, then
    1. Perform ! Call(promiseCapability.[[Reject]], undefined, « completion.[[Value]] »).
  4. Else,
    1. Perform AsyncFunctionStart(promiseCapability, ExpressionBody).
  5. Return ReturnCompletion(promiseCapability.[[Promise]]).

15.9.4 Runtime Semantics: InstantiateAsyncArrowFunctionExpression

The syntax-directed operation InstantiateAsyncArrowFunctionExpression takes optional argument name (a property key or a Private Name) and returns an ECMAScript function object. It is defined piecewise over the following productions:

AsyncArrowFunction : async AsyncArrowBindingIdentifier => AsyncConciseBody
  1. If name is not present, set name to "".
  2. Let env be the LexicalEnvironment of the running execution context.
  3. Let privateEnv be the running execution context's PrivateEnvironment.
  4. Let sourceText be the source text matched by AsyncArrowFunction.
  5. Let parameters be AsyncArrowBindingIdentifier.
  6. Let closure be OrdinaryFunctionCreate(%AsyncFunction.prototype%, sourceText, parameters, AsyncConciseBody, lexical-this, env, privateEnv).
  7. Perform SetFunctionName(closure, name).
  8. Return closure.
AsyncArrowFunction : CoverCallExpressionAndAsyncArrowHead => AsyncConciseBody
  1. If name is not present, set name to "".
  2. Let env be the LexicalEnvironment of the running execution context.
  3. Let privateEnv be the running execution context's PrivateEnvironment.
  4. Let sourceText be the source text matched by AsyncArrowFunction.
  5. Let head be the AsyncArrowHead that is covered by CoverCallExpressionAndAsyncArrowHead.
  6. Let parameters be the ArrowFormalParameters of head.
  7. Let closure be OrdinaryFunctionCreate(%AsyncFunction.prototype%, sourceText, parameters, AsyncConciseBody, lexical-this, env, privateEnv).
  8. Perform SetFunctionName(closure, name).
  9. Return closure.

15.9.5 Runtime Semantics: Evaluation

AsyncArrowFunction : async AsyncArrowBindingIdentifier => AsyncConciseBody CoverCallExpressionAndAsyncArrowHead => AsyncConciseBody
  1. Return InstantiateAsyncArrowFunctionExpression of AsyncArrowFunction.

15.10 Tail Position Calls

15.10.1 Static Semantics: IsInTailPosition ( call )

The abstract operation IsInTailPosition takes argument call (a CallExpression Parse Node, a MemberExpression Parse Node, or an OptionalChain Parse Node) and returns a Boolean. It performs the following steps when called:

  1. If IsStrict(call) is false, return false.
  2. If call is not contained within a FunctionBody, a ConciseBody, or an AsyncConciseBody, return false.
  3. Let body be the FunctionBody, ConciseBody, or AsyncConciseBody that most closely contains call.
  4. If body is the FunctionBody of a GeneratorBody, return false.
  5. If body is the FunctionBody of an AsyncFunctionBody, return false.
  6. If body is the FunctionBody of an AsyncGeneratorBody, return false.
  7. If body is an AsyncConciseBody, return false.
  8. Return the result of HasCallInTailPosition of body with argument call.
Note

Tail Position calls are only defined in strict mode code because of a common non-standard language extension (see 10.2.4) that enables observation of the chain of caller contexts.

15.10.2 Static Semantics: HasCallInTailPosition

The syntax-directed operation HasCallInTailPosition takes argument call (a CallExpression Parse Node, a MemberExpression Parse Node, or an OptionalChain Parse Node) and returns a Boolean.

Note 1

call is a Parse Node that represents a specific range of source text. When the following algorithms compare call to another Parse Node, it is a test of whether they represent the same source text.

Note 2

A potential tail position call that is immediately followed by return GetValue of the call result is also a possible tail position call. A function call cannot return a Reference Record, so such a GetValue operation will always return the same value as the actual function call result.

It is defined piecewise over the following productions:

StatementList : StatementList StatementListItem
  1. Let has be HasCallInTailPosition of StatementList with argument call.
  2. If has is true, return true.
  3. Return HasCallInTailPosition of StatementListItem with argument call.
FunctionStatementList : [empty] StatementListItem : Declaration Statement : VariableStatement EmptyStatement ExpressionStatement ContinueStatement BreakStatement ThrowStatement DebuggerStatement Block : { } ReturnStatement : return ; LabelledItem : FunctionDeclaration ForInOfStatement : for ( LeftHandSideExpression of AssignmentExpression ) Statement for ( var ForBinding of AssignmentExpression ) Statement for ( ForDeclaration of AssignmentExpression ) Statement CaseBlock : { }
  1. Return false.
IfStatement : if ( Expression ) Statement else Statement
  1. Let has be HasCallInTailPosition of the first Statement with argument call.
  2. If has is true, return true.
  3. Return HasCallInTailPosition of the second Statement with argument call.
IfStatement : if ( Expression ) Statement DoWhileStatement : do Statement while ( Expression ) ; WhileStatement : while ( Expression ) Statement ForStatement : for ( Expressionopt ; Expressionopt ; Expressionopt ) Statement for ( var VariableDeclarationList ; Expressionopt ; Expressionopt ) Statement for ( LexicalDeclaration Expressionopt ; Expressionopt ) Statement ForInOfStatement : for ( LeftHandSideExpression in Expression ) Statement for ( var ForBinding in Expression ) Statement for ( ForDeclaration in Expression ) Statement WithStatement : with ( Expression ) Statement
  1. Return HasCallInTailPosition of Statement with argument call.
LabelledStatement : LabelIdentifier : LabelledItem
  1. Return HasCallInTailPosition of LabelledItem with argument call.
ReturnStatement : return Expression ;
  1. Return HasCallInTailPosition of Expression with argument call.
SwitchStatement : switch ( Expression ) CaseBlock
  1. Return HasCallInTailPosition of CaseBlock with argument call.
CaseBlock : { CaseClausesopt DefaultClause CaseClausesopt }
  1. Let has be false.
  2. If the first CaseClauses is present, set has to HasCallInTailPosition of the first CaseClauses with argument call.
  3. If has is true, return true.
  4. Set has to HasCallInTailPosition of DefaultClause with argument call.
  5. If has is true, return true.
  6. If the second CaseClauses is present, set has to HasCallInTailPosition of the second CaseClauses with argument call.
  7. Return has.
CaseClauses : CaseClauses CaseClause
  1. Let has be HasCallInTailPosition of CaseClauses with argument call.
  2. If has is true, return true.
  3. Return HasCallInTailPosition of CaseClause with argument call.
CaseClause : case Expression : StatementListopt DefaultClause : default : StatementListopt
  1. If StatementList is present, return HasCallInTailPosition of StatementList with argument call.
  2. Return false.
TryStatement : try Block Catch
  1. Return HasCallInTailPosition of Catch with argument call.
TryStatement : try Block Finally try Block Catch Finally
  1. Return HasCallInTailPosition of Finally with argument call.
Catch : catch ( CatchParameter ) Block
  1. Return HasCallInTailPosition of Block with argument call.
AssignmentExpression : YieldExpression ArrowFunction AsyncArrowFunction LeftHandSideExpression = AssignmentExpression LeftHandSideExpression AssignmentOperator AssignmentExpression LeftHandSideExpression &&= AssignmentExpression LeftHandSideExpression ||= AssignmentExpression LeftHandSideExpression ??= AssignmentExpression BitwiseANDExpression : BitwiseANDExpression & EqualityExpression BitwiseXORExpression : BitwiseXORExpression ^ BitwiseANDExpression BitwiseORExpression : BitwiseORExpression | BitwiseXORExpression EqualityExpression : EqualityExpression == RelationalExpression EqualityExpression != RelationalExpression EqualityExpression === RelationalExpression EqualityExpression !== RelationalExpression RelationalExpression : RelationalExpression < ShiftExpression RelationalExpression > ShiftExpression RelationalExpression <= ShiftExpression RelationalExpression >= ShiftExpression RelationalExpression instanceof ShiftExpression RelationalExpression in ShiftExpression PrivateIdentifier in ShiftExpression ShiftExpression : ShiftExpression << AdditiveExpression ShiftExpression >> AdditiveExpression ShiftExpression >>> AdditiveExpression AdditiveExpression : AdditiveExpression + MultiplicativeExpression AdditiveExpression - MultiplicativeExpression MultiplicativeExpression : MultiplicativeExpression MultiplicativeOperator ExponentiationExpression ExponentiationExpression : UpdateExpression ** ExponentiationExpression UpdateExpression : LeftHandSideExpression ++ LeftHandSideExpression -- ++ UnaryExpression -- UnaryExpression UnaryExpression : delete UnaryExpression void UnaryExpression typeof UnaryExpression + UnaryExpression - UnaryExpression ~ UnaryExpression ! UnaryExpression AwaitExpression CallExpression : SuperCall ImportCall CallExpression [ Expression ] CallExpression . IdentifierName CallExpression . PrivateIdentifier NewExpression : new NewExpression MemberExpression : MemberExpression [ Expression ] MemberExpression . IdentifierName SuperProperty MetaProperty new MemberExpression Arguments MemberExpression . PrivateIdentifier PrimaryExpression : this IdentifierReference Literal ArrayLiteral ObjectLiteral FunctionExpression ClassExpression GeneratorExpression AsyncFunctionExpression AsyncGeneratorExpression RegularExpressionLiteral TemplateLiteral
  1. Return false.
Expression : AssignmentExpression Expression , AssignmentExpression
  1. Return HasCallInTailPosition of AssignmentExpression with argument call.
ConditionalExpression : ShortCircuitExpression ? AssignmentExpression : AssignmentExpression
  1. Let has be HasCallInTailPosition of the first AssignmentExpression with argument call.
  2. If has is true, return true.
  3. Return HasCallInTailPosition of the second AssignmentExpression with argument call.
LogicalANDExpression : LogicalANDExpression && BitwiseORExpression
  1. Return HasCallInTailPosition of BitwiseORExpression with argument call.
LogicalORExpression : LogicalORExpression || LogicalANDExpression
  1. Return HasCallInTailPosition of LogicalANDExpression with argument call.
CoalesceExpression : CoalesceExpressionHead ?? BitwiseORExpression
  1. Return HasCallInTailPosition of BitwiseORExpression with argument call.
CallExpression : CoverCallExpressionAndAsyncArrowHead CallExpression Arguments CallExpression TemplateLiteral
  1. If this CallExpression is call, return true.
  2. Return false.
OptionalExpression : MemberExpression OptionalChain CallExpression OptionalChain OptionalExpression OptionalChain
  1. Return HasCallInTailPosition of OptionalChain with argument call.
OptionalChain : ?. [ Expression ] ?. IdentifierName ?. PrivateIdentifier OptionalChain [ Expression ] OptionalChain . IdentifierName OptionalChain . PrivateIdentifier
  1. Return false.
OptionalChain : ?. Arguments OptionalChain Arguments
  1. If this OptionalChain is call, return true.
  2. Return false.
MemberExpression : MemberExpression TemplateLiteral
  1. If this MemberExpression is call, return true.
  2. Return false.
PrimaryExpression : CoverParenthesizedExpressionAndArrowParameterList
  1. Let expr be the ParenthesizedExpression that is covered by CoverParenthesizedExpressionAndArrowParameterList.
  2. Return HasCallInTailPosition of expr with argument call.
ParenthesizedExpression : ( Expression )
  1. Return HasCallInTailPosition of Expression with argument call.

15.10.3 PrepareForTailCall ( )

The abstract operation PrepareForTailCall takes no arguments and returns unused. It performs the following steps when called:

  1. Assert: The current execution context will not subsequently be used for the evaluation of any ECMAScript code or built-in functions. The invocation of Call subsequent to the invocation of this abstract operation will create and push a new execution context before performing any such evaluation.
  2. Discard all resources associated with the current execution context.
  3. Return unused.

A tail position call must either release any transient internal resources associated with the currently executing function execution context before invoking the target function or reuse those resources in support of the target function.

Note

For example, a tail position call should only grow an implementation's activation record stack by the amount that the size of the target function's activation record exceeds the size of the calling function's activation record. If the target function's activation record is smaller, then the total size of the stack should decrease.

16 ECMAScript Language: Scripts and Modules

16.1 Scripts

Syntax

Script : ScriptBodyopt ScriptBody : StatementList[~Yield, ~Await, ~Return]

16.1.1 Static Semantics: Early Errors

Script : ScriptBody ScriptBody : StatementList

16.1.2 Static Semantics: ScriptIsStrict

The syntax-directed operation ScriptIsStrict takes no arguments and returns a Boolean. It is defined piecewise over the following productions:

Script : ScriptBodyopt
  1. If ScriptBody is present and the Directive Prologue of ScriptBody contains a Use Strict Directive, return true; otherwise return false.

16.1.3 Runtime Semantics: Evaluation

Script : [empty]
  1. Return undefined.

16.1.4 Script Records

A Script Record encapsulates information about a script being evaluated. Each script record contains the fields listed in Table 39.

Table 39: Script Record Fields
Field Name Value Type Meaning
[[Realm]] a Realm Record The realm within which this script was created.
[[ECMAScriptCode]] a Script Parse Node The result of parsing the source text of this script.
[[LoadedModules]] a List of LoadedModuleRequest Records A map from the specifier strings imported by this script to the resolved Module Record. The list does not contain two different Records r1 and r2 such that ModuleRequestsEqual(r1, r2) is true.
[[HostDefined]] anything (default value is empty) Field reserved for use by host environments that need to associate additional information with a script.

16.1.5 ParseScript ( sourceText, realm, hostDefined )

The abstract operation ParseScript takes arguments sourceText (ECMAScript source text), realm (a Realm Record), and hostDefined (anything) and returns a Script Record or a non-empty List of SyntaxError objects. It creates a Script Record based upon the result of parsing sourceText as a Script. It performs the following steps when called:

  1. Let script be ParseText(sourceText, Script).
  2. If script is a List of errors, return script.
  3. Return Script Record { [[Realm]]: realm, [[ECMAScriptCode]]: script, [[LoadedModules]]: « », [[HostDefined]]: hostDefined }.
Note

An implementation may parse script source text and analyse it for Early Error conditions prior to evaluation of ParseScript for that script source text. However, the reporting of any errors must be deferred until the point where this specification actually performs ParseScript upon that source text.

16.1.6 ScriptEvaluation ( scriptRecord )

The abstract operation ScriptEvaluation takes argument scriptRecord (a Script Record) and returns either a normal completion containing an ECMAScript language value or an abrupt completion. It performs the following steps when called:

  1. Let globalEnv be scriptRecord.[[Realm]].[[GlobalEnv]].
  2. Let scriptContext be a new ECMAScript code execution context.
  3. Set the Function of scriptContext to null.
  4. Set the Realm of scriptContext to scriptRecord.[[Realm]].
  5. Set the ScriptOrModule of scriptContext to scriptRecord.
  6. Set the VariableEnvironment of scriptContext to globalEnv.
  7. Set the LexicalEnvironment of scriptContext to globalEnv.
  8. Set the PrivateEnvironment of scriptContext to null.
  9. Suspend the running execution context.
  10. Push scriptContext onto the execution context stack; scriptContext is now the running execution context.
  11. Let script be scriptRecord.[[ECMAScriptCode]].
  12. Let result be Completion(GlobalDeclarationInstantiation(script, globalEnv)).
  13. If result is a normal completion, then
    1. Set result to Completion(Evaluation of script).
    2. If result is a normal completion and result.[[Value]] is empty, then
      1. Set result to NormalCompletion(undefined).
  14. Suspend scriptContext and remove it from the execution context stack.
  15. Assert: The execution context stack is not empty.
  16. Resume the context that is now on the top of the execution context stack as the running execution context.
  17. Return ? result.

16.1.7 GlobalDeclarationInstantiation ( script, env )

The abstract operation GlobalDeclarationInstantiation takes arguments script (a Script Parse Node) and env (a Global Environment Record) and returns either a normal completion containing unused or a throw completion. script is the Script for which the execution context is being established. env is the global environment in which bindings are to be created.

Note 1

When an execution context is established for evaluating scripts, declarations are instantiated in the current global environment. Each global binding declared in the code is instantiated.

It performs the following steps when called:

  1. Let lexNames be the LexicallyDeclaredNames of script.
  2. Let varNames be the VarDeclaredNames of script.
  3. For each element name of lexNames, do
    1. If HasLexicalDeclaration(env, name) is true, throw a SyntaxError exception.
    2. Let hasRestrictedGlobal be ? HasRestrictedGlobalProperty(env, name).
    3. NOTE: Global var and function bindings (except those that are introduced by non-strict direct eval) are non-configurable and are therefore restricted global properties.
    4. If hasRestrictedGlobal is true, throw a SyntaxError exception.
  4. For each element name of varNames, do
    1. If HasLexicalDeclaration(env, name) is true, throw a SyntaxError exception.
  5. Let varDeclarations be the VarScopedDeclarations of script.
  6. Let functionsToInitialize be a new empty List.
  7. Let declaredFunctionNames be a new empty List.
  8. For each element d of varDeclarations, in reverse List order, do
    1. If d is not either a VariableDeclaration, a ForBinding, or a BindingIdentifier, then
      1. Assert: d is either a FunctionDeclaration, a GeneratorDeclaration, an AsyncFunctionDeclaration, or an AsyncGeneratorDeclaration.
      2. NOTE: If there are multiple function declarations for the same name, the last declaration is used.
      3. Let fn be the sole element of the BoundNames of d.
      4. If declaredFunctionNames does not contain fn, then
        1. Let fnDefinable be ? CanDeclareGlobalFunction(env, fn).
        2. If fnDefinable is false, throw a TypeError exception.
        3. Append fn to declaredFunctionNames.
        4. Insert d as the first element of functionsToInitialize.
  9. Let declaredVarNames be a new empty List.
  10. For each element d of varDeclarations, do
    1. If d is either a VariableDeclaration, a ForBinding, or a BindingIdentifier, then
      1. For each String vn of the BoundNames of d, do
        1. If declaredFunctionNames does not contain vn, then
          1. Let vnDefinable be ? CanDeclareGlobalVar(env, vn).
          2. If vnDefinable is false, throw a TypeError exception.
          3. If declaredVarNames does not contain vn, then
            1. Append vn to declaredVarNames.
  11. NOTE: No abnormal terminations occur after this algorithm step if the global object is an ordinary object. However, if the global object is a Proxy exotic object it may exhibit behaviours that cause abnormal terminations in some of the following steps.
  12. NOTE: Annex B.3.2.2 adds additional steps at this point.
  13. Let lexDeclarations be the LexicallyScopedDeclarations of script.
  14. Let privateEnv be null.
  15. For each element d of lexDeclarations, do
    1. NOTE: Lexically declared names are only instantiated here but not initialized.
    2. For each element dn of the BoundNames of d, do
      1. If IsConstantDeclaration of d is true, then
        1. Perform ? env.CreateImmutableBinding(dn, true).
      2. Else,
        1. Perform ? env.CreateMutableBinding(dn, false).
  16. For each Parse Node f of functionsToInitialize, do
    1. Let fn be the sole element of the BoundNames of f.
    2. Let fo be InstantiateFunctionObject of f with arguments env and privateEnv.
    3. Perform ? CreateGlobalFunctionBinding(env, fn, fo, false).
  17. For each String vn of declaredVarNames, do
    1. Perform ? CreateGlobalVarBinding(env, vn, false).
  18. Return unused.
Note 2

Early errors specified in 16.1.1 prevent name conflicts between function/var declarations and let/const/class declarations as well as redeclaration of let/const/class bindings for declaration contained within a single Script. However, such conflicts and redeclarations that span more than one Script are detected as runtime errors during GlobalDeclarationInstantiation. If any such errors are detected, no bindings are instantiated for the script. However, if the global object is defined using Proxy exotic objects then the runtime tests for conflicting declarations may be unreliable resulting in an abrupt completion and some global declarations not being instantiated. If this occurs, the code for the Script is not evaluated.

Unlike explicit var or function declarations, properties that are directly created on the global object result in global bindings that may be shadowed by let/const/class declarations.

16.2 Modules

Syntax

Module : ModuleBodyopt ModuleBody : ModuleItemList ModuleItemList : ModuleItem ModuleItemList ModuleItem ModuleItem : ImportDeclaration ExportDeclaration StatementListItem[~Yield, +Await, ~Return] ModuleExportName : IdentifierName StringLiteral

16.2.1 Module Semantics

16.2.1.1 Static Semantics: Early Errors

ModuleBody : ModuleItemList Note

The duplicate ExportedNames rule implies that multiple export default ExportDeclaration items within a ModuleBody is a Syntax Error. Additional error conditions relating to conflicting or duplicate declarations are checked during module linking prior to evaluation of a Module. If any such errors are detected the Module is not evaluated.

ModuleExportName : StringLiteral

16.2.1.2 Static Semantics: ImportedLocalNames ( importEntries )

The abstract operation ImportedLocalNames takes argument importEntries (a List of ImportEntry Records) and returns a List of Strings. It creates a List of all of the local name bindings defined by importEntries. It performs the following steps when called:

  1. Let localNames be a new empty List.
  2. For each ImportEntry Record i of importEntries, do
    1. Append i.[[LocalName]] to localNames.
  3. Return localNames.

16.2.1.3 ModuleRequest Records

A ModuleRequest Record represents the request to import a module with given import attributes. It consists of the following fields:

Table 40: ModuleRequest Record Fields
Field Name Value Type Meaning
[[Specifier]] a String The module specifier
[[Attributes]] a List of ImportAttribute Records The import attributes

A LoadedModuleRequest Record represents the request to import a module together with the resulting Module Record. It consists of the same fields defined in table Table 40, with the addition of [[Module]]:

Table 41: LoadedModuleRequest Record Fields
Field Name Value Type Meaning
[[Specifier]] a String The module specifier
[[Attributes]] a List of ImportAttribute Records The import attributes
[[Module]] a Module Record The loaded module corresponding to this module request

An ImportAttribute Record consists of the following fields:

Table 42: ImportAttribute Record Fields
Field Name Value Type Meaning
[[Key]] a String The attribute key
[[Value]] a String The attribute value

16.2.1.3.1 ModuleRequestsEqual ( left, right )

The abstract operation ModuleRequestsEqual takes arguments left (a ModuleRequest Record or a LoadedModuleRequest Record) and right (a ModuleRequest Record or a LoadedModuleRequest Record) and returns a Boolean. It performs the following steps when called:

  1. If left.[[Specifier]] is not right.[[Specifier]], return false.
  2. Let leftAttrs be left.[[Attributes]].
  3. Let rightAttrs be right.[[Attributes]].
  4. Let leftAttrsCount be the number of elements in leftAttrs.
  5. Let rightAttrsCount be the number of elements in rightAttrs.
  6. If leftAttrsCountrightAttrsCount, return false.
  7. For each ImportAttribute Record l of leftAttrs, do
    1. If rightAttrs does not contain an ImportAttribute Record r such that l.[[Key]] is r.[[Key]] and l.[[Value]] is r.[[Value]], return false.
  8. Return true.

16.2.1.4 Static Semantics: ModuleRequests

The syntax-directed operation ModuleRequests takes no arguments and returns a List of ModuleRequest Records. It is defined piecewise over the following productions:

Module : [empty]
  1. Return a new empty List.
ModuleItemList : ModuleItem
  1. Return the ModuleRequests of ModuleItem.
ModuleItemList : ModuleItemList ModuleItem
  1. Let requests be the ModuleRequests of ModuleItemList.
  2. Let additionalRequests be the ModuleRequests of ModuleItem.
  3. For each ModuleRequest Record mr of additionalRequests, do
    1. If requests does not contain a ModuleRequest Record mr2 such that ModuleRequestsEqual(mr, mr2) is true, then
      1. Append mr to requests.
  4. Return requests.
ModuleItem : StatementListItem
  1. Return a new empty List.
ImportDeclaration : import ImportClause FromClause ;
  1. Let specifier be the SV of FromClause.
  2. Return a List whose sole element is the ModuleRequest Record { [[Specifier]]: specifier, [[Attributes]]: « » }.
ImportDeclaration : import ImportClause FromClause WithClause ;
  1. Let specifier be the SV of FromClause.
  2. Let attributes be WithClauseToAttributes of WithClause.
  3. Return a List whose sole element is the ModuleRequest Record { [[Specifier]]: specifier, [[Attributes]]: attributes }.
ImportDeclaration : import ModuleSpecifier ;
  1. Let specifier be the SV of ModuleSpecifier.
  2. Return a List whose sole element is the ModuleRequest Record { [[Specifier]]: specifier, [[Attributes]]: « » }.
ImportDeclaration : import ModuleSpecifier WithClause ;
  1. Let specifier be the SV of ModuleSpecifier.
  2. Let attributes be WithClauseToAttributes of WithClause.
  3. Return a List whose sole element is the ModuleRequest Record { [[Specifier]]: specifier, [[Attributes]]: attributes }.
ExportDeclaration : export ExportFromClause FromClause ;
  1. Let specifier be the SV of FromClause.
  2. Return a List whose sole element is the ModuleRequest Record { [[Specifier]]: specifier, [[Attributes]]: « » }.
ExportDeclaration : export ExportFromClause FromClause WithClause ;
  1. Let specifier be the SV of FromClause.
  2. Let attributes be WithClauseToAttributes of WithClause.
  3. Return a List whose sole element is the ModuleRequest Record { [[Specifier]]: specifier, [[Attributes]]: attributes }.
ExportDeclaration : export NamedExports ; export VariableStatement export Declaration export default HoistableDeclaration export default ClassDeclaration export default AssignmentExpression ;
  1. Return a new empty List.

16.2.1.5 Abstract Module Records

A Module Record encapsulates structural information about the imports and exports of a single module. This information is used to link the imports and exports of sets of connected modules. A Module Record includes four fields that are only used when evaluating a module.

For specification purposes Module Record values are values of the Record specification type and can be thought of as existing in a simple object-oriented hierarchy where Module Record is an abstract class with both abstract and concrete subclasses. This specification defines the abstract subclass named Cyclic Module Record and its concrete subclass named Source Text Module Record. Other specifications and implementations may define additional Module Record subclasses corresponding to alternative module definition facilities that they defined.

Module Record defines the fields listed in Table 43. All Module Definition subclasses include at least those fields. Module Record also defines the abstract method list in Table 44. All Module definition subclasses must provide concrete implementations of these abstract methods.

Table 43: Module Record Fields
Field Name Value Type Meaning
[[Realm]] a Realm Record The Realm within which this module was created.
[[Environment]] a Module Environment Record or empty The Environment Record containing the top level bindings for this module. This field is set when the module is linked.
[[Namespace]] an Object or empty The Module Namespace Object (28.3) if one has been created for this module.
[[HostDefined]] anything (default value is undefined) Field reserved for use by host environments that need to associate additional information with a module.
Table 44: Abstract Methods of Module Records
Method Purpose
LoadRequestedModules([hostDefined])

Prepares the module for linking by recursively loading all its dependencies, and returns a promise.

GetExportedNames([exportStarSet])

Return a list of all names that are either directly or indirectly exported from this module.

LoadRequestedModules must have completed successfully prior to invoking this method.

ResolveExport(exportName [, resolveSet])

Return the binding of a name exported by this module. Bindings are represented by a ResolvedBinding Record, of the form { [[Module]]: Module Record, [[BindingName]]: String | namespace }. If the export is a Module Namespace Object without a direct binding in any module, [[BindingName]] will be set to namespace. Return null if the name cannot be resolved, or ambiguous if multiple bindings were found.

Each time this operation is called with a specific exportName, resolveSet pair as arguments it must return the same result.

LoadRequestedModules must have completed successfully prior to invoking this method.

Link()

Prepare the module for evaluation by transitively resolving all module dependencies and creating a Module Environment Record.

LoadRequestedModules must have completed successfully prior to invoking this method.

Evaluate()

Returns a promise for the evaluation of this module and its dependencies, resolving on successful evaluation or if it has already been evaluated successfully, and rejecting for an evaluation error or if it has already been evaluated unsuccessfully. If the promise is rejected, hosts are expected to handle the promise rejection and rethrow the evaluation error.

Link must have completed successfully prior to invoking this method.

16.2.1.5.1 EvaluateModuleSync ( module )

The abstract operation EvaluateModuleSync takes argument module (a Module Record) and returns either a normal completion containing unused or a throw completion. It synchronously evaluates module, provided that the caller guarantees that module's evaluation will return an already settled promise. It performs the following steps when called:

  1. Assert: module is not a Cyclic Module Record.
  2. Let promise be module.Evaluate().
  3. Assert: promise.[[PromiseState]] is either fulfilled or rejected.
  4. If promise.[[PromiseState]] is rejected, then
    1. If promise.[[PromiseIsHandled]] is false, perform HostPromiseRejectionTracker(promise, "handle").
    2. Set promise.[[PromiseIsHandled]] to true.
    3. Return ThrowCompletion(promise.[[PromiseResult]]).
  5. Return unused.

16.2.1.6 Cyclic Module Records

A Cyclic Module Record is used to represent information about a module that can participate in dependency cycles with other modules that are subclasses of the Cyclic Module Record type. Module Records that are not subclasses of the Cyclic Module Record type must not participate in dependency cycles with Source Text Module Records.

In addition to the fields defined in Table 43 Cyclic Module Records have the additional fields listed in Table 45

Table 45: Additional Fields of Cyclic Module Records
Field Name Value Type Meaning
[[Status]] new, unlinked, linking, linked, evaluating, evaluating-async, or evaluated Initially new. Transitions to unlinked, linking, linked, evaluating, possibly evaluating-async, evaluated (in that order) as the module progresses throughout its lifecycle. evaluating-async indicates this module is queued to execute on completion of its asynchronous dependencies or it is a module whose [[HasTLA]] field is true that has been executed and is pending top-level completion.
[[EvaluationError]] a throw completion or empty A throw completion representing the exception that occurred during evaluation. undefined if no exception occurred or if [[Status]] is not evaluated.
[[DFSAncestorIndex]] an integer or empty Auxiliary field used during Link and Evaluate only. If [[Status]] is either linking or evaluating, this is either the module's depth-first traversal index or that of an "earlier" module in the same strongly connected component.
[[RequestedModules]] a List of ModuleRequest Records A List of the ModuleRequest Records associated with the imports in this module. The List is in source text occurrence order of the imports.
[[LoadedModules]] a List of LoadedModuleRequest Records A map from the specifier strings used by the module represented by this record to request the importation of a module with the relative import attributes to the resolved Module Record. The list does not contain two different Records r1 and r2 such that ModuleRequestsEqual(r1, r2) is true.
[[CycleRoot]] a Cyclic Module Record or empty The first visited module of the cycle, the root DFS ancestor of the strongly connected component. For a module not in a cycle, this would be the module itself. Once Evaluate has completed, a module's [[DFSAncestorIndex]] is the depth-first traversal index of its [[CycleRoot]].
[[HasTLA]] a Boolean Whether this module is individually asynchronous (for example, if it's a Source Text Module Record containing a top-level await). Having an asynchronous dependency does not mean this field is true. This field must not change after the module is parsed.
[[AsyncEvaluationOrder]] unset, an integer, or done This field is initially set to unset, and remains unset for fully synchronous modules. For modules that are either themselves asynchronous or have an asynchronous dependency, it is set to an integer that determines the order in which execution of pending modules is queued by 16.2.1.6.1.3.4. Once the pending module is executed, the field is set to done.
[[TopLevelCapability]] a PromiseCapability Record or empty If this module is the [[CycleRoot]] of some cycle, and Evaluate() was called on some module in that cycle, this field contains the PromiseCapability Record for that entire evaluation. It is used to settle the Promise object that is returned from the Evaluate() abstract method. This field will be empty for any dependencies of that module, unless a top-level Evaluate() has been initiated for some of those dependencies.
[[AsyncParentModules]] a List of Cyclic Module Records If this module or a dependency has [[HasTLA]] true, and execution is in progress, this tracks the parent importers of this module for the top-level execution job. These parent modules will not start executing before this module has successfully completed execution.
[[PendingAsyncDependencies]] an integer or empty If this module has any asynchronous dependencies, this tracks the number of asynchronous dependency modules remaining to execute for this module. A module with asynchronous dependencies will be executed when this field reaches 0 and there are no execution errors.

In addition to the methods defined in Table 44 Cyclic Module Records have the additional methods listed in Table 46

Table 46: Additional Abstract Methods of Cyclic Module Records
Method Purpose
InitializeEnvironment() Initialize the Environment Record of the module, including resolving all imported bindings, and create the module's execution context.
ExecuteModule([promiseCapability]) Evaluate the module's code within its execution context. If this module has true in [[HasTLA]], then a PromiseCapability Record is passed as an argument, and the method is expected to resolve or reject the given capability. In this case, the method must not throw an exception, but instead reject the PromiseCapability Record if necessary.

A GraphLoadingState Record is a Record that contains information about the loading process of a module graph. It's used to continue loading after a call to HostLoadImportedModule. Each GraphLoadingState Record has the fields defined in Table 47:

Table 47: GraphLoadingState Record Fields
Field Name Value Type Meaning
[[PromiseCapability]] a PromiseCapability Record The promise to resolve when the loading process finishes.
[[IsLoading]] a Boolean It is true if the loading process has not finished yet, neither successfully nor with an error.
[[PendingModulesCount]] a non-negative integer It tracks the number of pending HostLoadImportedModule calls.
[[Visited]] a List of Cyclic Module Records It is a list of the Cyclic Module Records that have been already loaded by the current loading process, to avoid infinite loops with circular dependencies.
[[HostDefined]] anything (default value is empty) It contains host-defined data to pass from the LoadRequestedModules caller to HostLoadImportedModule.

16.2.1.6.1 Implementation of Module Record Abstract Methods

The following are the concrete methods for Cyclic Module Record that implement the corresponding Module Record abstract methods defined in Table 44.

16.2.1.6.1.1 LoadRequestedModules ( [ hostDefined ] )

The LoadRequestedModules concrete method of a Cyclic Module Record module takes optional argument hostDefined (anything) and returns a Promise. It populates the [[LoadedModules]] of all the Module Records in the dependency graph of module (most of the work is done by the auxiliary function InnerModuleLoading). It takes an optional hostDefined parameter that is passed to the HostLoadImportedModule hook. It performs the following steps when called:

  1. If hostDefined is not present, let hostDefined be empty.
  2. Let pc be ! NewPromiseCapability(%Promise%).
  3. Let state be the GraphLoadingState Record { [[IsLoading]]: true, [[PendingModulesCount]]: 1, [[Visited]]: « », [[PromiseCapability]]: pc, [[HostDefined]]: hostDefined }.
  4. Perform InnerModuleLoading(state, module).
  5. Return pc.[[Promise]].
Note
The hostDefined parameter can be used to pass additional information necessary to fetch the imported modules. It is used, for example, by HTML to set the correct fetch destination for <link rel="preload" as="..."> tags. import() expressions never set the hostDefined parameter.

16.2.1.6.1.1.1 InnerModuleLoading ( state, module )

The abstract operation InnerModuleLoading takes arguments state (a GraphLoadingState Record) and module (a Module Record) and returns unused. It is used by LoadRequestedModules to recursively perform the actual loading process for module's dependency graph. It performs the following steps when called:

  1. Assert: state.[[IsLoading]] is true.
  2. If module is a Cyclic Module Record, module.[[Status]] is new, and state.[[Visited]] does not contain module, then
    1. Append module to state.[[Visited]].
    2. Let requestedModulesCount be the number of elements in module.[[RequestedModules]].
    3. Set state.[[PendingModulesCount]] to state.[[PendingModulesCount]] + requestedModulesCount.
    4. For each ModuleRequest Record request of module.[[RequestedModules]], do
      1. If AllImportAttributesSupported(request.[[Attributes]]) is false, then
        1. Let error be ThrowCompletion(a newly created SyntaxError object).
        2. Perform ContinueModuleLoading(state, error).
      2. Else if module.[[LoadedModules]] contains a LoadedModuleRequest Record record such that ModuleRequestsEqual(record, request) is true, then
        1. Perform InnerModuleLoading(state, record.[[Module]]).
      3. Else,
        1. Perform HostLoadImportedModule(module, request, state.[[HostDefined]], state).
        2. NOTE: HostLoadImportedModule will call FinishLoadingImportedModule, which re-enters the graph loading process through ContinueModuleLoading.
      4. If state.[[IsLoading]] is false, return unused.
  3. Assert: state.[[PendingModulesCount]] ≥ 1.
  4. Set state.[[PendingModulesCount]] to state.[[PendingModulesCount]] - 1.
  5. If state.[[PendingModulesCount]] = 0, then
    1. Set state.[[IsLoading]] to false.
    2. For each Cyclic Module Record loaded of state.[[Visited]], do
      1. If loaded.[[Status]] is new, set loaded.[[Status]] to unlinked.
    3. Perform ! Call(state.[[PromiseCapability]].[[Resolve]], undefined, « undefined »).
  6. Return unused.

16.2.1.6.1.1.2 ContinueModuleLoading ( state, moduleCompletion )

The abstract operation ContinueModuleLoading takes arguments state (a GraphLoadingState Record) and moduleCompletion (either a normal completion containing a Module Record or a throw completion) and returns unused. It is used to re-enter the loading process after a call to HostLoadImportedModule. It performs the following steps when called:

  1. If state.[[IsLoading]] is false, return unused.
  2. If moduleCompletion is a normal completion, then
    1. Perform InnerModuleLoading(state, moduleCompletion.[[Value]]).
  3. Else,
    1. Set state.[[IsLoading]] to false.
    2. Perform ! Call(state.[[PromiseCapability]].[[Reject]], undefined, « moduleCompletion.[[Value]] »).
  4. Return unused.

16.2.1.6.1.2 Link ( )

The Link concrete method of a Cyclic Module Record module takes no arguments and returns either a normal completion containing unused or a throw completion. On success, Link transitions this module's [[Status]] from unlinked to linked. On failure, an exception is thrown and this module's [[Status]] remains unlinked. (Most of the work is done by the auxiliary function InnerModuleLinking.) It performs the following steps when called:

  1. Assert: module.[[Status]] is one of unlinked, linked, evaluating-async, or evaluated.
  2. Let stack be a new empty List.
  3. Let result be Completion(InnerModuleLinking(module, stack, 0)).
  4. If result is an abrupt completion, then
    1. For each Cyclic Module Record m of stack, do
      1. Assert: m.[[Status]] is linking.
      2. Set m.[[Status]] to unlinked.
    2. Assert: module.[[Status]] is unlinked.
    3. Return ? result.
  5. Assert: module.[[Status]] is one of linked, evaluating-async, or evaluated.
  6. Assert: stack is empty.
  7. Return unused.

16.2.1.6.1.2.1 InnerModuleLinking ( module, stack, index )

The abstract operation InnerModuleLinking takes arguments module (a Module Record), stack (a List of Cyclic Module Records), and index (a non-negative integer) and returns either a normal completion containing a non-negative integer or a throw completion. It is used by Link to perform the actual linking process for module, as well as recursively on all other modules in the dependency graph. The stack and index parameters, as well as a module's [[DFSAncestorIndex]] field, keep track of the depth-first search (DFS) traversal. In particular, [[DFSAncestorIndex]] is used to discover strongly connected components (SCCs), such that all modules in an SCC transition to linked together. It performs the following steps when called:

  1. If module is not a Cyclic Module Record, then
    1. Perform ? module.Link().
    2. Return index.
  2. If module.[[Status]] is one of linking, linked, evaluating-async, or evaluated, then
    1. Return index.
  3. Assert: module.[[Status]] is unlinked.
  4. Set module.[[Status]] to linking.
  5. Let moduleIndex be index.
  6. Set module.[[DFSAncestorIndex]] to index.
  7. Set index to index + 1.
  8. Append module to stack.
  9. For each ModuleRequest Record request of module.[[RequestedModules]], do
    1. Let requiredModule be GetImportedModule(module, request).
    2. Set index to ? InnerModuleLinking(requiredModule, stack, index).
    3. If requiredModule is a Cyclic Module Record, then
      1. Assert: requiredModule.[[Status]] is one of linking, linked, evaluating-async, or evaluated.
      2. Assert: requiredModule.[[Status]] is linking if and only if stack contains requiredModule.
      3. If requiredModule.[[Status]] is linking, then
        1. Set module.[[DFSAncestorIndex]] to min(module.[[DFSAncestorIndex]], requiredModule.[[DFSAncestorIndex]]).
  10. Perform ? module.InitializeEnvironment().
  11. Assert: module occurs exactly once in stack.
  12. Assert: module.[[DFSAncestorIndex]]moduleIndex.
  13. If module.[[DFSAncestorIndex]] = moduleIndex, then
    1. Let done be false.
    2. Repeat, while done is false,
      1. Let requiredModule be the last element of stack.
      2. Remove the last element of stack.
      3. Assert: requiredModule is a Cyclic Module Record.
      4. Set requiredModule.[[Status]] to linked.
      5. If requiredModule and module are the same Module Record, set done to true.
  14. Return index.

16.2.1.6.1.3 Evaluate ( )

The Evaluate concrete method of a Cyclic Module Record module takes no arguments and returns a Promise. Evaluate transitions this module's [[Status]] from linked to either evaluating-async or evaluated. The first time it is called on a module in a given strongly connected component, Evaluate creates and returns a Promise which resolves when the module has finished evaluating. This Promise is stored in the [[TopLevelCapability]] field of the [[CycleRoot]] for the component. Future invocations of Evaluate on any module in the component return the same Promise. (Most of the work is done by the auxiliary function InnerModuleEvaluation.) It performs the following steps when called:

  1. Assert: This call to Evaluate is not happening at the same time as another call to Evaluate within the surrounding agent.
  2. Assert: module.[[Status]] is one of linked, evaluating-async, or evaluated.
  3. If module.[[Status]] is either evaluating-async or evaluated, set module to module.[[CycleRoot]].
  4. If module.[[TopLevelCapability]] is not empty, then
    1. Return module.[[TopLevelCapability]].[[Promise]].
  5. Let stack be a new empty List.
  6. Let capability be ! NewPromiseCapability(%Promise%).
  7. Set module.[[TopLevelCapability]] to capability.
  8. Let result be Completion(InnerModuleEvaluation(module, stack, 0)).
  9. If result is an abrupt completion, then
    1. For each Cyclic Module Record m of stack, do
      1. Assert: m.[[Status]] is evaluating.
      2. Assert: m.[[AsyncEvaluationOrder]] is unset.
      3. Set m.[[Status]] to evaluated.
      4. Set m.[[EvaluationError]] to result.
    2. Assert: module.[[Status]] is evaluated.
    3. Assert: module.[[EvaluationError]] and result are the same Completion Record.
    4. Perform ! Call(capability.[[Reject]], undefined, « result.[[Value]] »).
  10. Else,
    1. Assert: module.[[Status]] is either evaluating-async or evaluated.
    2. Assert: module.[[EvaluationError]] is empty.
    3. If module.[[Status]] is evaluated, then
      1. NOTE: This implies that evaluation of module completed synchronously.
      2. Assert: module.[[AsyncEvaluationOrder]] is unset.
      3. Perform ! Call(capability.[[Resolve]], undefined, « undefined »).
    4. Assert: stack is empty.
  11. Return capability.[[Promise]].

16.2.1.6.1.3.1 InnerModuleEvaluation ( module, stack, index )

The abstract operation InnerModuleEvaluation takes arguments module (a Module Record), stack (a List of Cyclic Module Records), and index (a non-negative integer) and returns either a normal completion containing a non-negative integer or a throw completion. It is used by Evaluate to perform the actual evaluation process for module, as well as recursively on all other modules in the dependency graph. The stack and index parameters, as well as module's [[DFSAncestorIndex]] field, are used the same way as in InnerModuleLinking. It performs the following steps when called:

  1. If module is not a Cyclic Module Record, then
    1. Perform ? EvaluateModuleSync(module).
    2. Return index.
  2. If module.[[Status]] is either evaluating-async or evaluated, then
    1. If module.[[EvaluationError]] is empty, return index.
    2. Otherwise, return ? module.[[EvaluationError]].
  3. If module.[[Status]] is evaluating, return index.
  4. Assert: module.[[Status]] is linked.
  5. Set module.[[Status]] to evaluating.
  6. Let moduleIndex be index.
  7. Set module.[[DFSAncestorIndex]] to index.
  8. Set module.[[PendingAsyncDependencies]] to 0.
  9. Set index to index + 1.
  10. Append module to stack.
  11. For each ModuleRequest Record request of module.[[RequestedModules]], do
    1. Let requiredModule be GetImportedModule(module, request).
    2. Set index to ? InnerModuleEvaluation(requiredModule, stack, index).
    3. If requiredModule is a Cyclic Module Record, then
      1. Assert: requiredModule.[[Status]] is one of evaluating, evaluating-async, or evaluated.
      2. Assert: requiredModule.[[Status]] is evaluating if and only if stack contains requiredModule.
      3. If requiredModule.[[Status]] is evaluating, then
        1. Set module.[[DFSAncestorIndex]] to min(module.[[DFSAncestorIndex]], requiredModule.[[DFSAncestorIndex]]).
      4. Else,
        1. Set requiredModule to requiredModule.[[CycleRoot]].
        2. Assert: requiredModule.[[Status]] is either evaluating-async or evaluated.
        3. If requiredModule.[[EvaluationError]] is not empty, return ? requiredModule.[[EvaluationError]].
      5. If requiredModule.[[AsyncEvaluationOrder]] is an integer, then
        1. Set module.[[PendingAsyncDependencies]] to module.[[PendingAsyncDependencies]] + 1.
        2. Append module to requiredModule.[[AsyncParentModules]].
  12. If module.[[PendingAsyncDependencies]] > 0 or module.[[HasTLA]] is true, then
    1. Assert: module.[[AsyncEvaluationOrder]] is unset.
    2. Set module.[[AsyncEvaluationOrder]] to IncrementModuleAsyncEvaluationCount().
    3. If module.[[PendingAsyncDependencies]] = 0, perform ExecuteAsyncModule(module).
  13. Else,
    1. Perform ? module.ExecuteModule().
  14. Assert: module occurs exactly once in stack.
  15. Assert: module.[[DFSAncestorIndex]]moduleIndex.
  16. If module.[[DFSAncestorIndex]] = moduleIndex, then
    1. Let done be false.
    2. Repeat, while done is false,
      1. Let requiredModule be the last element of stack.
      2. Remove the last element of stack.
      3. Assert: requiredModule is a Cyclic Module Record.
      4. Assert: requiredModule.[[AsyncEvaluationOrder]] is either an integer or unset.
      5. If requiredModule.[[AsyncEvaluationOrder]] is unset, set requiredModule.[[Status]] to evaluated.
      6. Otherwise, set requiredModule.[[Status]] to evaluating-async.
      7. If requiredModule and module are the same Module Record, set done to true.
      8. Set requiredModule.[[CycleRoot]] to module.
  17. Return index.
Note 1

A module is evaluating while it is being traversed by InnerModuleEvaluation. A module is evaluated on execution completion or evaluating-async during execution if its [[HasTLA]] field is true or if it has asynchronous dependencies.

Note 2

Any modules depending on a module of an asynchronous cycle when that cycle is not evaluating will instead depend on the execution of the root of the cycle via [[CycleRoot]]. This ensures that the cycle state can be treated as a single strongly connected component through its root module state.

16.2.1.6.1.3.2 ExecuteAsyncModule ( module )

The abstract operation ExecuteAsyncModule takes argument module (a Cyclic Module Record) and returns unused. It performs the following steps when called:

  1. Assert: module.[[Status]] is either evaluating or evaluating-async.
  2. Assert: module.[[HasTLA]] is true.
  3. Let capability be ! NewPromiseCapability(%Promise%).
  4. Let fulfilledClosure be a new Abstract Closure with no parameters that captures module and performs the following steps when called:
    1. Perform AsyncModuleExecutionFulfilled(module).
    2. Return NormalCompletion(undefined).
  5. Let onFulfilled be CreateBuiltinFunction(fulfilledClosure, 0, "", « »).
  6. Let rejectedClosure be a new Abstract Closure with parameters (error) that captures module and performs the following steps when called:
    1. Perform AsyncModuleExecutionRejected(module, error).
    2. Return NormalCompletion(undefined).
  7. Let onRejected be CreateBuiltinFunction(rejectedClosure, 0, "", « »).
  8. Perform PerformPromiseThen(capability.[[Promise]], onFulfilled, onRejected).
  9. Perform ! module.ExecuteModule(capability).
  10. Return unused.

16.2.1.6.1.3.3 GatherAvailableAncestors ( module, execList )

The abstract operation GatherAvailableAncestors takes arguments module (a Cyclic Module Record) and execList (a List of Cyclic Module Records) and returns unused. It performs the following steps when called:

  1. For each Cyclic Module Record m of module.[[AsyncParentModules]], do
    1. If execList does not contain m and m.[[CycleRoot]].[[EvaluationError]] is empty, then
      1. Assert: m.[[Status]] is evaluating-async.
      2. Assert: m.[[EvaluationError]] is empty.
      3. Assert: m.[[AsyncEvaluationOrder]] is an integer.
      4. Assert: m.[[PendingAsyncDependencies]] > 0.
      5. Set m.[[PendingAsyncDependencies]] to m.[[PendingAsyncDependencies]] - 1.
      6. If m.[[PendingAsyncDependencies]] = 0, then
        1. Append m to execList.
        2. If m.[[HasTLA]] is false, perform GatherAvailableAncestors(m, execList).
  2. Return unused.
Note

When an asynchronous execution for a root module is fulfilled, this function determines the list of modules which are able to synchronously execute together on this completion, populating them in execList.

16.2.1.6.1.3.4 AsyncModuleExecutionFulfilled ( module )

The abstract operation AsyncModuleExecutionFulfilled takes argument module (a Cyclic Module Record) and returns unused. It performs the following steps when called:

  1. If module.[[Status]] is evaluated, then
    1. Assert: module.[[EvaluationError]] is not empty.
    2. Return unused.
  2. Assert: module.[[Status]] is evaluating-async.
  3. Assert: module.[[AsyncEvaluationOrder]] is an integer.
  4. Assert: module.[[EvaluationError]] is empty.
  5. Set module.[[AsyncEvaluationOrder]] to done.
  6. Set module.[[Status]] to evaluated.
  7. If module.[[TopLevelCapability]] is not empty, then
    1. Assert: module.[[CycleRoot]] and module are the same Module Record.
    2. Perform ! Call(module.[[TopLevelCapability]].[[Resolve]], undefined, « undefined »).
  8. Let execList be a new empty List.
  9. Perform GatherAvailableAncestors(module, execList).
  10. Assert: All elements of execList have their [[AsyncEvaluationOrder]] field set to an integer, [[PendingAsyncDependencies]] field set to 0, and [[EvaluationError]] field set to empty.
  11. Let sortedExecList be a List whose elements are the elements of execList, sorted by their [[AsyncEvaluationOrder]] field in ascending order.
  12. For each Cyclic Module Record m of sortedExecList, do
    1. If m.[[Status]] is evaluated, then
      1. Assert: m.[[EvaluationError]] is not empty.
    2. Else if m.[[HasTLA]] is true, then
      1. Perform ExecuteAsyncModule(m).
    3. Else,
      1. Let result be m.ExecuteModule().
      2. If result is an abrupt completion, then
        1. Perform AsyncModuleExecutionRejected(m, result.[[Value]]).
      3. Else,
        1. Set m.[[AsyncEvaluationOrder]] to done.
        2. Set m.[[Status]] to evaluated.
        3. If m.[[TopLevelCapability]] is not empty, then
          1. Assert: m.[[CycleRoot]] and m are the same Module Record.
          2. Perform ! Call(m.[[TopLevelCapability]].[[Resolve]], undefined, « undefined »).
  13. Return unused.

16.2.1.6.1.3.5 AsyncModuleExecutionRejected ( module, error )

The abstract operation AsyncModuleExecutionRejected takes arguments module (a Cyclic Module Record) and error (an ECMAScript language value) and returns unused. It performs the following steps when called:

  1. If module.[[Status]] is evaluated, then
    1. Assert: module.[[EvaluationError]] is not empty.
    2. Return unused.
  2. Assert: module.[[Status]] is evaluating-async.
  3. Assert: module.[[AsyncEvaluationOrder]] is an integer.
  4. Assert: module.[[EvaluationError]] is empty.
  5. Set module.[[EvaluationError]] to ThrowCompletion(error).
  6. Set module.[[Status]] to evaluated.
  7. Set module.[[AsyncEvaluationOrder]] to done.
  8. NOTE: module.[[AsyncEvaluationOrder]] is set to done for symmetry with AsyncModuleExecutionFulfilled. In InnerModuleEvaluation, the value of a module's [[AsyncEvaluationOrder]] internal slot is unused when its [[EvaluationError]] internal slot is not empty.
  9. For each Cyclic Module Record m of module.[[AsyncParentModules]], do
    1. Perform AsyncModuleExecutionRejected(m, error).
  10. If module.[[TopLevelCapability]] is not empty, then
    1. Assert: module.[[CycleRoot]] and module are the same Module Record.
    2. Perform ! Call(module.[[TopLevelCapability]].[[Reject]], undefined, « error »).
  11. Return unused.

16.2.1.6.2 Example Cyclic Module Record Graphs

This non-normative section gives a series of examples of the linking and evaluation of a few common module graphs, with a specific focus on how errors can occur.

First consider the following simple module graph:

Figure 2: A simple module graph
A module graph in which module A depends on module B, and module B depends on module C

Let's first assume that there are no error conditions. When a host first calls A.LoadRequestedModules(), this will complete successfully by assumption, and recursively load the dependencies of B and C as well (respectively, C and none), and then set A.[[Status]] = B.[[Status]] = C.[[Status]] = unlinked. Then, when the host calls A.Link(), it will complete successfully (again by assumption) such that A.[[Status]] = B.[[Status]] = C.[[Status]] = linked. These preparatory steps can be performed at any time. Later, when the host is ready to incur any possible side effects of the modules, it can call A.Evaluate(), which will complete successfully, returning a Promise resolving to undefined (again by assumption), recursively having evaluated first C and then B. Each module's [[Status]] at this point will be evaluated.

Consider then cases involving linking errors, after a successful call to A.LoadRequestedModules(). If InnerModuleLinking of C succeeds but, thereafter, fails for B, for example because it imports something that C does not provide, then the original A.Link() will fail, and both A and B's [[Status]] remain unlinked. C's [[Status]] has become linked, though.

Finally, consider a case involving evaluation errors after a successful call to Link(). If InnerModuleEvaluation of C succeeds but, thereafter, fails for B, for example because B contains code that throws an exception, then the original A.Evaluate() will fail, returning a rejected Promise. The resulting exception will be recorded in both A and B's [[EvaluationError]] fields, and their [[Status]] will become evaluated. C will also become evaluated but, in contrast to A and B, will remain without an [[EvaluationError]], as it successfully completed evaluation. Storing the exception ensures that any time a host tries to reuse A or B by calling their Evaluate() method, it will encounter the same exception. (Hosts are not required to reuse Cyclic Module Records; similarly, hosts are not required to expose the exception objects thrown by these methods. However, the specification enables such uses.)

Now consider a different type of error condition:

Figure 3: A module graph with an unresolvable module
A module graph in which module A depends on a missing (unresolvable) module, represented by ???

In this scenario, module A declares a dependency on some other module, but no Module Record exists for that module, i.e. HostLoadImportedModule calls FinishLoadingImportedModule with an exception when asked for it. This could occur for a variety of reasons, such as the corresponding resource not existing, or the resource existing but ParseModule returning some errors when trying to parse the resulting source text. Hosts can choose to expose the cause of failure via the completion they pass to FinishLoadingImportedModule. In any case, this exception causes a loading failure, which results in A's [[Status]] remaining new.

The difference here between loading, linking and evaluation errors is due to the following characteristic:

  • Evaluation must be only performed once, as it can cause side effects; it is thus important to remember whether evaluation has already been performed, even if unsuccessfully. (In the error case, it makes sense to also remember the exception because otherwise subsequent Evaluate() calls would have to synthesize a new one.)
  • Linking, on the other hand, is side-effect-free, and thus even if it fails, it can be retried at a later time with no issues.
  • Loading closely interacts with the host, and it may be desirable for some of them to allow users to retry failed loads (for example, if the failure is caused by temporarily bad network conditions).

Now, consider a module graph with a cycle:

Figure 4: A cyclic module graph
A module graph in which module A depends on module B and C, but module B also depends on module A

Here we assume that the entry point is module A, so that the host proceeds by calling A.LoadRequestedModules(), which performs InnerModuleLoading on A. This in turn calls InnerModuleLoading on B and C. Because of the cycle, this again triggers InnerModuleLoading on A, but at this point it is a no-op since A's dependencies loading has already been triggered during this LoadRequestedModules process. When all the modules in the graph have been successfully loaded, their [[Status]] transitions from new to unlinked at the same time.

Then the host proceeds by calling A.Link(), which performs InnerModuleLinking on A. This in turn calls InnerModuleLinking on B. Because of the cycle, this again triggers InnerModuleLinking on A, but at this point it is a no-op since A.[[Status]] is already linking. B.[[Status]] itself remains linking when control gets back to A and InnerModuleLinking is triggered on C. After this returns with C.[[Status]] being linked, both A and B transition from linking to linked together; this is by design, since they form a strongly connected component. It's possible to transition the status of modules in the same SCC at the same time because during this phase the module graph is traversed with a depth-first search.

An analogous story occurs for the evaluation phase of a cyclic module graph, in the success case.

Now consider a case where A has a linking error; for example, it tries to import a binding from C that does not exist. In that case, the above steps still occur, including the early return from the second call to InnerModuleLinking on A. However, once we unwind back to the original InnerModuleLinking on A, it fails during InitializeEnvironment, namely right after C.ResolveExport(). The thrown SyntaxError exception propagates up to A.Link, which resets all modules that are currently on its stack (these are always exactly the modules that are still linking). Hence both A and B become unlinked. Note that C is left as linked.

Alternatively, consider a case where A has an evaluation error; for example, its source code throws an exception. In that case, the evaluation-time analogue of the above steps still occurs, including the early return from the second call to InnerModuleEvaluation on A. However, once we unwind back to the original InnerModuleEvaluation on A, it fails by assumption. The exception thrown propagates up to A.Evaluate(), which records the error in all modules that are currently on its stack (i.e., the modules that are still evaluating) as well as via [[AsyncParentModules]], which form a chain for modules which contain or depend on top-level await through the whole dependency graph through the AsyncModuleExecutionRejected algorithm. Hence both A and B become evaluated and the exception is recorded in both A and B's [[EvaluationError]] fields, while C is left as evaluated with no [[EvaluationError]].

Lastly, consider a module graph with a cycle, where all modules complete asynchronously:

Figure 5: An asynchronous cyclic module graph
A module graph in which module A depends on module B and C, module B depends on module D, module C depends on module D and E, and module D depends on module A

Loading and linking happen as before, and all modules end up with [[Status]] set to linked.

Calling A.Evaluate() calls InnerModuleEvaluation on A, B, and D, which all transition to evaluating. Then InnerModuleEvaluation is called on A again, which is a no-op because it is already evaluating. At this point, D.[[PendingAsyncDependencies]] is 0, so ExecuteAsyncModule(D) is called and we call D.ExecuteModule with a new PromiseCapability tracking the asynchronous execution of D. We unwind back to the InnerModuleEvaluation on B, setting B.[[PendingAsyncDependencies]] to 1 and B.[[AsyncEvaluationOrder]] to 1. We unwind back to the original InnerModuleEvaluation on A, setting A.[[PendingAsyncDependencies]] to 1. In the next iteration of the loop over A's dependencies, we call InnerModuleEvaluation on C and thus on D (again a no-op) and E. As E has no dependencies and is not part of a cycle, we call ExecuteAsyncModule(E) in the same manner as D and E is immediately removed from the stack. We unwind once more to the InnerModuleEvaluation on C, setting C.[[AsyncEvaluationOrder]] to 3. Now we finish the loop over A's dependencies, set A.[[AsyncEvaluationOrder]] to 4, and remove the entire strongly connected component from the stack, transitioning all of the modules to evaluating-async at once. At this point, the fields of the modules are as given in Table 48.

Table 48: Module fields after the initial Evaluate() call
Field
Module
A B C D E
[[DFSAncestorIndex]] 0 0 0 0 4
[[Status]] evaluating-async evaluating-async evaluating-async evaluating-async evaluating-async
[[AsyncEvaluationOrder]] 4 1 3 0 2
[[AsyncParentModules]] « » « A » « A » « B, C » « C »
[[PendingAsyncDependencies]] 2 (B and C) 1 (D) 2 (D and E) 0 0

Let us assume that E finishes executing first. When that happens, AsyncModuleExecutionFulfilled is called, E.[[Status]] is set to evaluated and C.[[PendingAsyncDependencies]] is decremented to become 1. The fields of the updated modules are as given in Table 49.

Table 49: Module fields after module E finishes executing
Field
Module
C E
[[DFSAncestorIndex]] 0 4
[[Status]] evaluating-async evaluated
[[AsyncEvaluationOrder]] 3 done
[[AsyncParentModules]] « A » « C »
[[PendingAsyncDependencies]] 1 (D) 0

D is next to finish (as it was the only module that was still executing). When that happens, AsyncModuleExecutionFulfilled is called again and D.[[Status]] is set to evaluated. Its ancestors available for execution are B (whose [[AsyncEvaluationOrder]] is 1) and C (whose [[AsyncEvaluationOrder]] is 3), thus B will be handled first: B.[[PendingAsyncDependencies]] is decremented to become 0, ExecuteAsyncModule is called on B, and it starts executing. C.[[PendingAsyncDependencies]] is also decremented to become 0, and C starts executing (potentially in parallel to B if B contains an await). The fields of the updated modules are as given in Table 50.

Table 50: Module fields after module D finishes executing
Field
Module
B C D
[[DFSAncestorIndex]] 0 0 0
[[Status]] evaluating-async evaluating-async evaluated
[[AsyncEvaluationOrder]] 1 3 done
[[AsyncParentModules]] « A » « A » « B, C »
[[PendingAsyncDependencies]] 0 0 0

Let us assume that C finishes executing next. When that happens, AsyncModuleExecutionFulfilled is called again, C.[[Status]] is set to evaluated and A.[[PendingAsyncDependencies]] is decremented to become 1. The fields of the updated modules are as given in Table 51.

Table 51: Module fields after module C finishes executing
Field
Module
A C
[[DFSAncestorIndex]] 0 0
[[Status]] evaluating-async evaluated
[[AsyncEvaluationOrder]] 4 done
[[AsyncParentModules]] « » « A »
[[PendingAsyncDependencies]] 1 (B) 0

Then, B finishes executing. When that happens, AsyncModuleExecutionFulfilled is called again and B.[[Status]] is set to evaluated. A.[[PendingAsyncDependencies]] is decremented to become 0, so ExecuteAsyncModule is called and it starts executing. The fields of the updated modules are as given in Table 52.

Table 52: Module fields after module B finishes executing
Field
Module
A B
[[DFSAncestorIndex]] 0 0
[[Status]] evaluating-async evaluated
[[AsyncEvaluationOrder]] 4 done
[[AsyncParentModules]] « » « A »
[[PendingAsyncDependencies]] 0 0

Finally, A finishes executing. When that happens, AsyncModuleExecutionFulfilled is called again and A.[[Status]] is set to evaluated. At this point, the Promise in A.[[TopLevelCapability]] (which was returned from A.Evaluate()) is resolved, and this concludes the handling of this module graph. The fields of the updated module are as given in Table 53.

Table 53: Module fields after module A finishes executing
Field
Module
A
[[DFSAncestorIndex]] 0
[[Status]] evaluated
[[AsyncEvaluationOrder]] done
[[AsyncParentModules]] « »
[[PendingAsyncDependencies]] 0

Alternatively, consider a failure case where C fails execution and returns an error before B has finished executing. When that happens, AsyncModuleExecutionRejected is called, which sets C.[[Status]] to evaluated and C.[[EvaluationError]] to the error. It then propagates this error to all of the AsyncParentModules by performing AsyncModuleExecutionRejected on each of them. The fields of the updated modules are as given in Table 54.

Table 54: Module fields after module C finishes with an error
Field
Module
A C
[[DFSAncestorIndex]] 0 0
[[Status]] evaluated evaluated
[[AsyncEvaluationOrder]] done done
[[AsyncParentModules]] « » « A »
[[PendingAsyncDependencies]] 1 (B) 0
[[EvaluationError]] empty C's evaluation error

A will be rejected with the same error as C since C will call AsyncModuleExecutionRejected on A with C's error. A.[[Status]] is set to evaluated. At this point the Promise in A.[[TopLevelCapability]] (which was returned from A.Evaluate()) is rejected. The fields of the updated module are as given in Table 55.

Table 55: Module fields after module A is rejected
Field
Module
A
[[DFSAncestorIndex]] 0
[[Status]] evaluated
[[AsyncEvaluationOrder]] done
[[AsyncParentModules]] « »
[[PendingAsyncDependencies]] 0
[[EvaluationError]] C's Evaluation Error

Then, B finishes executing without an error. When that happens, AsyncModuleExecutionFulfilled is called again and B.[[Status]] is set to evaluated. GatherAvailableAncestors is called on B. However, A.[[CycleRoot]] is A which has an evaluation error, so it will not be added to the returned sortedExecList and AsyncModuleExecutionFulfilled will return without further processing. Any future importer of B will resolve the rejection of B.[[CycleRoot]].[[EvaluationError]] from the evaluation error from C that was set on the cycle root A. The fields of the updated modules are as given in Table 56.

Table 56: Module fields after module B finishes executing in an erroring graph
Field
Module
A B
[[DFSAncestorIndex]] 0 0
[[Status]] evaluated evaluated
[[AsyncEvaluationOrder]] 4 1
[[AsyncParentModules]] « » « A »
[[PendingAsyncDependencies]] 0 0
[[EvaluationError]] C's Evaluation Error empty

16.2.1.7 Source Text Module Records

A Source Text Module Record is used to represent information about a module that was defined from ECMAScript source text (11) that was parsed using the goal symbol Module. Its fields contain digested information about the names that are imported and exported by the module, and its concrete methods use these digests to link and evaluate the module.

A Source Text Module Record can exist in a module graph with other subclasses of the abstract Module Record type, and can participate in cycles with other subclasses of the Cyclic Module Record type.

In addition to the fields defined in Table 45, Source Text Module Records have the additional fields listed in Table 57. Each of these fields is initially set in ParseModule.

Table 57: Additional Fields of Source Text Module Records
Field Name Value Type Meaning
[[ECMAScriptCode]] a Parse Node The result of parsing the source text of this module using Module as the goal symbol.
[[Context]] an ECMAScript code execution context or empty The execution context associated with this module. It is empty until the module's environment has been initialized.
[[ImportMeta]] an Object or empty An object exposed through the import.meta meta property. It is empty until it is accessed by ECMAScript code.
[[ImportEntries]] a List of ImportEntry Records A List of ImportEntry records derived from the code of this module.
[[LocalExportEntries]] a List of ExportEntry Records A List of ExportEntry records derived from the code of this module that correspond to declarations that occur within the module.
[[IndirectExportEntries]] a List of ExportEntry Records A List of ExportEntry records derived from the code of this module that correspond to reexported imports that occur within the module or exports from export * as namespace declarations.
[[StarExportEntries]] a List of ExportEntry Records A List of ExportEntry records derived from the code of this module that correspond to export * declarations that occur within the module, not including export * as namespace declarations.

An ImportEntry Record is a Record that digests information about a single declarative import. Each ImportEntry Record has the fields defined in Table 58:

Table 58: ImportEntry Record Fields
Field Name Value Type Meaning
[[ModuleRequest]] a ModuleRequest Record ModuleRequest Record representing the ModuleSpecifier and import attributes of the ImportDeclaration.
[[ImportName]] a String or namespace-object The name under which the desired binding is exported by the module identified by [[ModuleRequest]]. The value namespace-object indicates that the import request is for the target module's namespace object.
[[LocalName]] a String The name that is used to locally access the imported value from within the importing module.
Note 1

Table 59 gives examples of ImportEntry records fields used to represent the syntactic import forms:

Table 59 (Informative): Import Forms Mappings to ImportEntry Records
Import Statement Form [[ModuleRequest]] [[ImportName]] [[LocalName]]
import v from "mod"; "mod" "default" "v"
import * as ns from "mod"; "mod" namespace-object "ns"
import {x} from "mod"; "mod" "x" "x"
import {x as v} from "mod"; "mod" "x" "v"
import "mod"; An ImportEntry Record is not created.

An ExportEntry Record is a Record that digests information about a single declarative export. Each ExportEntry Record has the fields defined in Table 60:

Table 60: ExportEntry Record Fields
Field Name Value Type Meaning
[[ExportName]] a String or null The name used to export this binding by this module.
[[ModuleRequest]] a ModuleRequest Record or null The ModuleRequest Record representing the ModuleSpecifier and import attributes of the ExportDeclaration. null if the ExportDeclaration does not have a ModuleSpecifier.
[[ImportName]] a String, null, all, or all-but-default The name under which the desired binding is exported by the module identified by [[ModuleRequest]]. null if the ExportDeclaration does not have a ModuleSpecifier. all is used for export * as ns from "mod" declarations. all-but-default is used for export * from "mod" declarations.
[[LocalName]] a String or null The name that is used to locally access the exported value from within the importing module. null if the exported value is not locally accessible from within the module.
Note 2

Table 61 gives examples of the ExportEntry record fields used to represent the syntactic export forms:

Table 61 (Informative): Export Forms Mappings to ExportEntry Records
Export Statement Form [[ExportName]] [[ModuleRequest]] [[ImportName]] [[LocalName]]
export var v; "v" null null "v"
export default function f() {} "default" null null "f"
export default function () {} "default" null null "*default*"
export default 42; "default" null null "*default*"
export {x}; "x" null null "x"
export {v as x}; "x" null null "v"
export {x} from "mod"; "x" "mod" "x" null
export {v as x} from "mod"; "x" "mod" "v" null
export * from "mod"; null "mod" all-but-default null
export * as ns from "mod"; "ns" "mod" all null

The following definitions specify the required concrete methods and other abstract operations for Source Text Module Records

16.2.1.7.1 ParseModule ( sourceText, realm, hostDefined )

The abstract operation ParseModule takes arguments sourceText (ECMAScript source text), realm (a Realm Record), and hostDefined (anything) and returns a Source Text Module Record or a non-empty List of SyntaxError objects. It creates a Source Text Module Record based upon the result of parsing sourceText as a Module. It performs the following steps when called:

  1. Let body be ParseText(sourceText, Module).
  2. If body is a List of errors, return body.
  3. Let requestedModules be the ModuleRequests of body.
  4. Let importEntries be the ImportEntries of body.
  5. Let importedBoundNames be ImportedLocalNames(importEntries).
  6. Let indirectExportEntries be a new empty List.
  7. Let localExportEntries be a new empty List.
  8. Let starExportEntries be a new empty List.
  9. Let exportEntries be the ExportEntries of body.
  10. For each ExportEntry Record ee of exportEntries, do
    1. If ee.[[ModuleRequest]] is null, then
      1. If importedBoundNames does not contain ee.[[LocalName]], then
        1. Append ee to localExportEntries.
      2. Else,
        1. Let ie be the element of importEntries whose [[LocalName]] is ee.[[LocalName]].
        2. If ie.[[ImportName]] is namespace-object, then
          1. NOTE: This is a re-export of an imported module namespace object.
          2. Append ee to localExportEntries.
        3. Else,
          1. NOTE: This is a re-export of a single name.
          2. Append the ExportEntry Record { [[ModuleRequest]]: ie.[[ModuleRequest]], [[ImportName]]: ie.[[ImportName]], [[LocalName]]: null, [[ExportName]]: ee.[[ExportName]] } to indirectExportEntries.
    2. Else if ee.[[ImportName]] is all-but-default, then
      1. Assert: ee.[[ExportName]] is null.
      2. Append ee to starExportEntries.
    3. Else,
      1. Append ee to indirectExportEntries.
  11. Let async be body Contains await.
  12. Return Source Text Module Record { [[Realm]]: realm, [[Environment]]: empty, [[Namespace]]: empty, [[CycleRoot]]: empty, [[HasTLA]]: async, [[AsyncEvaluationOrder]]: unset, [[TopLevelCapability]]: empty, [[AsyncParentModules]]: « », [[PendingAsyncDependencies]]: empty, [[Status]]: new, [[EvaluationError]]: empty, [[HostDefined]]: hostDefined, [[ECMAScriptCode]]: body, [[Context]]: empty, [[ImportMeta]]: empty, [[RequestedModules]]: requestedModules, [[LoadedModules]]: « », [[ImportEntries]]: importEntries, [[LocalExportEntries]]: localExportEntries, [[IndirectExportEntries]]: indirectExportEntries, [[StarExportEntries]]: starExportEntries, [[DFSAncestorIndex]]: empty }.
Note

An implementation may parse module source text and analyse it for Early Error conditions prior to the evaluation of ParseModule for that module source text. However, the reporting of any errors must be deferred until the point where this specification actually performs ParseModule upon that source text.

16.2.1.7.2 Implementation of Module Record Abstract Methods

The following are the concrete methods for Source Text Module Record that implement the corresponding Module Record abstract methods defined in Table 44.

16.2.1.7.2.1 GetExportedNames ( [ exportStarSet ] )

The GetExportedNames concrete method of a Source Text Module Record module takes optional argument exportStarSet (a List of Source Text Module Records) and returns a List of Strings. It performs the following steps when called:

  1. Assert: module.[[Status]] is not new.
  2. If exportStarSet is not present, set exportStarSet to a new empty List.
  3. If exportStarSet contains module, then
    1. Assert: We've reached the starting point of an export * circularity.
    2. Return a new empty List.
  4. Append module to exportStarSet.
  5. Let exportedNames be a new empty List.
  6. For each ExportEntry Record e of module.[[LocalExportEntries]], do
    1. Assert: module provides the direct binding for this export.
    2. Assert: e.[[ExportName]] is not null.
    3. Append e.[[ExportName]] to exportedNames.
  7. For each ExportEntry Record e of module.[[IndirectExportEntries]], do
    1. Assert: module imports a specific binding for this export.
    2. Assert: e.[[ExportName]] is not null.
    3. Append e.[[ExportName]] to exportedNames.
  8. For each ExportEntry Record e of module.[[StarExportEntries]], do
    1. Assert: e.[[ModuleRequest]] is not null.
    2. Let requestedModule be GetImportedModule(module, e.[[ModuleRequest]]).
    3. Let starNames be requestedModule.GetExportedNames(exportStarSet).
    4. For each element n of starNames, do
      1. If n is not "default", then
        1. If exportedNames does not contain n, then
          1. Append n to exportedNames.
  9. Return exportedNames.
Note

GetExportedNames does not filter out or throw an exception for names that have ambiguous star export bindings.

16.2.1.7.2.2 ResolveExport ( exportName [ , resolveSet ] )

The ResolveExport concrete method of a Source Text Module Record module takes argument exportName (a String) and optional argument resolveSet (a List of Records with fields [[Module]] (a Module Record) and [[ExportName]] (a String)) and returns a ResolvedBinding Record, null, or ambiguous.

ResolveExport attempts to resolve an imported binding to the actual defining module and local binding name. The defining module may be the module represented by the Module Record this method was invoked on or some other module that is imported by that module. The parameter resolveSet is used to detect unresolved circular import/export paths. If a pair consisting of specific Module Record and exportName is reached that is already in resolveSet, an import circularity has been encountered. Before recursively calling ResolveExport, a pair consisting of module and exportName is added to resolveSet.

If a defining module is found, a ResolvedBinding Record { [[Module]], [[BindingName]] } is returned. This record identifies the resolved binding of the originally requested export, unless this is the export of a namespace with no local binding. In this case, [[BindingName]] will be set to namespace. If no definition was found or the request is found to be circular, null is returned. If the request is found to be ambiguous, ambiguous is returned.

It performs the following steps when called:

  1. Assert: module.[[Status]] is not new.
  2. If resolveSet is not present, set resolveSet to a new empty List.
  3. For each Record { [[Module]], [[ExportName]] } r of resolveSet, do
    1. If module and r.[[Module]] are the same Module Record and exportName is r.[[ExportName]], then
      1. Assert: This is a circular import request.
      2. Return null.
  4. Append the Record { [[Module]]: module, [[ExportName]]: exportName } to resolveSet.
  5. For each ExportEntry Record e of module.[[LocalExportEntries]], do
    1. If e.[[ExportName]] is exportName, then
      1. Assert: module provides the direct binding for this export.
      2. Return ResolvedBinding Record { [[Module]]: module, [[BindingName]]: e.[[LocalName]] }.
  6. For each ExportEntry Record e of module.[[IndirectExportEntries]], do
    1. If e.[[ExportName]] is exportName, then
      1. Assert: e.[[ModuleRequest]] is not null.
      2. Let importedModule be GetImportedModule(module, e.[[ModuleRequest]]).
      3. If e.[[ImportName]] is all, then
        1. Assert: module does not provide the direct binding for this export.
        2. Return ResolvedBinding Record { [[Module]]: importedModule, [[BindingName]]: namespace }.
      4. Else,
        1. Assert: module imports a specific binding for this export.
        2. Assert: e.[[ImportName]] is a String.
        3. Return importedModule.ResolveExport(e.[[ImportName]], resolveSet).
  7. If exportName is "default", then
    1. Assert: A default export was not explicitly defined by this module.
    2. Return null.
    3. NOTE: A default export cannot be provided by an export * from "mod" declaration.
  8. Let starResolution be null.
  9. For each ExportEntry Record e of module.[[StarExportEntries]], do
    1. Assert: e.[[ModuleRequest]] is not null.
    2. Let importedModule be GetImportedModule(module, e.[[ModuleRequest]]).
    3. Let resolution be importedModule.ResolveExport(exportName, resolveSet).
    4. If resolution is ambiguous, return ambiguous.
    5. If resolution is not null, then
      1. Assert: resolution is a ResolvedBinding Record.
      2. If starResolution is null, then
        1. Set starResolution to resolution.
      3. Else,
        1. Assert: There is more than one * import that includes the requested name.
        2. If resolution.[[Module]] and starResolution.[[Module]] are not the same Module Record, return ambiguous.
        3. If resolution.[[BindingName]] is not starResolution.[[BindingName]] and either resolution.[[BindingName]] or starResolution.[[BindingName]] is namespace, return ambiguous.
        4. If resolution.[[BindingName]] is a String, starResolution.[[BindingName]] is a String, and resolution.[[BindingName]] is not starResolution.[[BindingName]], return ambiguous.
  10. Return starResolution.

16.2.1.7.3 Implementation of Cyclic Module Record Abstract Methods

The following are the concrete methods for Source Text Module Record that implement the corresponding Cyclic Module Record abstract methods defined in Table 46.

16.2.1.7.3.1 InitializeEnvironment ( )

The InitializeEnvironment concrete method of a Source Text Module Record module takes no arguments and returns either a normal completion containing unused or a throw completion. It performs the following steps when called:

  1. For each ExportEntry Record e of module.[[IndirectExportEntries]], do
    1. Assert: e.[[ExportName]] is not null.
    2. Let resolution be module.ResolveExport(e.[[ExportName]]).
    3. If resolution is either null or ambiguous, throw a SyntaxError exception.
    4. Assert: resolution is a ResolvedBinding Record.
  2. Assert: All named exports from module are resolvable.
  3. Let realm be module.[[Realm]].
  4. Assert: realm is not undefined.
  5. Let env be NewModuleEnvironment(realm.[[GlobalEnv]]).
  6. Set module.[[Environment]] to env.
  7. For each ImportEntry Record in of module.[[ImportEntries]], do
    1. Let importedModule be GetImportedModule(module, in.[[ModuleRequest]]).
    2. If in.[[ImportName]] is namespace-object, then
      1. Let namespace be GetModuleNamespace(importedModule).
      2. Perform ! env.CreateImmutableBinding(in.[[LocalName]], true).
      3. Perform ! env.InitializeBinding(in.[[LocalName]], namespace).
    3. Else,
      1. Let resolution be importedModule.ResolveExport(in.[[ImportName]]).
      2. If resolution is either null or ambiguous, throw a SyntaxError exception.
      3. If resolution.[[BindingName]] is namespace, then
        1. Let namespace be GetModuleNamespace(resolution.[[Module]]).
        2. Perform ! env.CreateImmutableBinding(in.[[LocalName]], true).
        3. Perform ! env.InitializeBinding(in.[[LocalName]], namespace).
      4. Else,
        1. Perform CreateImportBinding(env, in.[[LocalName]], resolution.[[Module]], resolution.[[BindingName]]).
  8. Let moduleContext be a new ECMAScript code execution context.
  9. Set the Function of moduleContext to null.
  10. Assert: module.[[Realm]] is not undefined.
  11. Set the Realm of moduleContext to module.[[Realm]].
  12. Set the ScriptOrModule of moduleContext to module.
  13. Set the VariableEnvironment of moduleContext to module.[[Environment]].
  14. Set the LexicalEnvironment of moduleContext to module.[[Environment]].
  15. Set the PrivateEnvironment of moduleContext to null.
  16. Set module.[[Context]] to moduleContext.
  17. Push moduleContext onto the execution context stack; moduleContext is now the running execution context.
  18. Let code be module.[[ECMAScriptCode]].
  19. Let varDeclarations be the VarScopedDeclarations of code.
  20. Let declaredVarNames be a new empty List.
  21. For each element d of varDeclarations, do
    1. For each element dn of the BoundNames of d, do
      1. If declaredVarNames does not contain dn, then
        1. Perform ! env.CreateMutableBinding(dn, false).
        2. Perform ! env.InitializeBinding(dn, undefined).
        3. Append dn to declaredVarNames.
  22. Let lexDeclarations be the LexicallyScopedDeclarations of code.
  23. Let privateEnv be null.
  24. For each element d of lexDeclarations, do
    1. For each element dn of the BoundNames of d, do
      1. If IsConstantDeclaration of d is true, then
        1. Perform ! env.CreateImmutableBinding(dn, true).
      2. Else,
        1. Perform ! env.CreateMutableBinding(dn, false).
      3. If d is either a FunctionDeclaration, a GeneratorDeclaration, an AsyncFunctionDeclaration, or an AsyncGeneratorDeclaration, then
        1. Let fo be InstantiateFunctionObject of d with arguments env and privateEnv.
        2. Perform ! env.InitializeBinding(dn, fo).
  25. Remove moduleContext from the execution context stack.
  26. Return unused.

16.2.1.7.3.2 ExecuteModule ( [ capability ] )

The ExecuteModule concrete method of a Source Text Module Record module takes optional argument capability (a PromiseCapability Record) and returns either a normal completion containing unused or a throw completion. It performs the following steps when called:

  1. Let moduleContext be a new ECMAScript code execution context.
  2. Set the Function of moduleContext to null.
  3. Set the Realm of moduleContext to module.[[Realm]].
  4. Set the ScriptOrModule of moduleContext to module.
  5. Assert: module has been linked and declarations in its module environment have been instantiated.
  6. Set the VariableEnvironment of moduleContext to module.[[Environment]].
  7. Set the LexicalEnvironment of moduleContext to module.[[Environment]].
  8. Suspend the running execution context.
  9. If module.[[HasTLA]] is false, then
    1. Assert: capability is not present.
    2. Push moduleContext onto the execution context stack; moduleContext is now the running execution context.
    3. Let result be Completion(Evaluation of module.[[ECMAScriptCode]]).
    4. Suspend moduleContext and remove it from the execution context stack.
    5. Resume the context that is now on the top of the execution context stack as the running execution context.
    6. If result is an abrupt completion, then
      1. Return ? result.
  10. Else,
    1. Assert: capability is a PromiseCapability Record.
    2. Perform AsyncBlockStart(capability, module.[[ECMAScriptCode]], moduleContext).
  11. Return unused.

16.2.1.8 Synthetic Module Records

A Synthetic Module Record is used to represent information about a module that is defined by specifications. Its exported names are statically defined at creation, while their corresponding values can change over time using SetSyntheticModuleExport. It has no imports or dependencies.

Note
A Synthetic Module Record could be used for defining a variety of module types: for example, JSON modules or CSS modules.

In addition to the fields defined in Table 43 Synthetic Module Records have the additional fields listed in Table 62.

Table 62: Additional Fields of Synthetic Module Records
Field Name Value Type Meaning
[[ExportNames]] a List of Strings The names of the exports of the module. This list does not contain duplicates.
[[EvaluationSteps]] an Abstract Closure The initialization logic to perform upon evaluation of the module, taking the Synthetic Module Record as its sole argument. It must not modify [[ExportNames]]. It may return an abrupt completion.

16.2.1.8.1 CreateDefaultExportSyntheticModule ( defaultExport )

The abstract operation CreateDefaultExportSyntheticModule takes argument defaultExport (an ECMAScript language value) and returns a Synthetic Module Record. It creates a Synthetic Module Record whose default export is defaultExport. It performs the following steps when called:

  1. Let realm be the current Realm Record.
  2. Let setDefaultExport be a new Abstract Closure with parameters (module) that captures defaultExport and performs the following steps when called:
    1. Perform SetSyntheticModuleExport(module, "default", defaultExport).
    2. Return NormalCompletion(unused).
  3. Return the Synthetic Module Record { [[Realm]]: realm, [[Environment]]: empty, [[Namespace]]: empty, [[HostDefined]]: undefined, [[ExportNames]]: « "default" », [[EvaluationSteps]]: setDefaultExport }.

16.2.1.8.2 ParseJSONModule ( source )

The abstract operation ParseJSONModule takes argument source (a String) and returns either a normal completion containing a Synthetic Module Record, or a throw completion. It performs the following steps when called:

  1. Let json be ? ParseJSON(source).
  2. Return CreateDefaultExportSyntheticModule(json).

16.2.1.8.3 SetSyntheticModuleExport ( module, exportName, exportValue )

The abstract operation SetSyntheticModuleExport takes arguments module (a Synthetic Module Record), exportName (a String), and exportValue (an ECMAScript language value) and returns unused. It can be used to set or change the exported value for an existing export of a Synthetic Module Record. It performs the following steps when called:

  1. Assert: module.[[ExportNames]] contains exportName.
  2. Let envRec be module.[[Environment]].
  3. Assert: envRec is not empty.
  4. Perform envRec.SetMutableBinding(exportName, exportValue, true).
  5. Return unused.

16.2.1.8.4 Implementation of Module Record Abstract Methods

The following are the concrete methods for Synthetic Module Record that implement the corresponding Module Record abstract methods defined in Table 44.

16.2.1.8.4.1 LoadRequestedModules ( )

The LoadRequestedModules concrete method of a Synthetic Module Record module takes no arguments and returns a Promise. It performs the following steps when called:

  1. Return ! PromiseResolve(%Promise%, undefined).
Note
Synthetic Module Records have no dependencies.

16.2.1.8.4.2 GetExportedNames ( )

The GetExportedNames concrete method of a Synthetic Module Record module takes no arguments and returns a List of Strings. It performs the following steps when called:

  1. Return module.[[ExportNames]].

16.2.1.8.4.3 ResolveExport ( exportName )

The ResolveExport concrete method of a Synthetic Module Record module takes argument exportName (a String) and returns a ResolvedBinding Record or null. It performs the following steps when called:

  1. If module.[[ExportNames]] does not contain exportName, return null.
  2. Return ResolvedBinding Record { [[Module]]: module, [[BindingName]]: exportName }.

16.2.1.8.4.4 Link ( )

The Link concrete method of a Synthetic Module Record module takes no arguments and returns a normal completion containing unused. It performs the following steps when called:

  1. Let realm be module.[[Realm]].
  2. Let env be NewModuleEnvironment(realm.[[GlobalEnv]]).
  3. Set module.[[Environment]] to env.
  4. For each String exportName of module.[[ExportNames]], do
    1. Perform ! env.CreateMutableBinding(exportName, false).
    2. Perform ! env.InitializeBinding(exportName, undefined).
  5. Return NormalCompletion(unused).

16.2.1.8.4.5 Evaluate ( )

The Evaluate concrete method of a Synthetic Module Record module takes no arguments and returns a Promise. It performs the following steps when called:

  1. Let moduleContext be a new ECMAScript code execution context.
  2. Set the Function of moduleContext to null.
  3. Set the Realm of moduleContext to module.[[Realm]].
  4. Set the ScriptOrModule of moduleContext to module.
  5. Set the VariableEnvironment of moduleContext to module.[[Environment]].
  6. Set the LexicalEnvironment of moduleContext to module.[[Environment]].
  7. Suspend the running execution context.
  8. Push moduleContext onto the execution context stack; moduleContext is now the running execution context.
  9. Let steps be module.[[EvaluationSteps]].
  10. Let result be Completion(steps(module)).
  11. Suspend moduleContext and remove it from the execution context stack.
  12. Resume the context that is now on the top of the execution context stack as the running execution context.
  13. Let pc be ! NewPromiseCapability(%Promise%).
  14. IfAbruptRejectPromise(result, pc).
  15. Perform ! Call(pc.[[Resolve]], undefined, « undefined »).
  16. Return pc.[[Promise]].

16.2.1.9 GetImportedModule ( referrer, request )

The abstract operation GetImportedModule takes arguments referrer (a Cyclic Module Record) and request (a ModuleRequest Record) and returns a Module Record. It performs the following steps when called:

  1. Let records be a List consisting of each LoadedModuleRequest Record r of referrer.[[LoadedModules]] such that ModuleRequestsEqual(r, request) is true.
  2. Assert: records has exactly one element, since LoadRequestedModules has completed successfully on referrer prior to invoking this abstract operation.
  3. Let record be the sole element of records.
  4. Return record.[[Module]].

16.2.1.10 HostLoadImportedModule ( referrer, moduleRequest, hostDefined, payload )

The host-defined abstract operation HostLoadImportedModule takes arguments referrer (a Script Record, a Cyclic Module Record, or a Realm Record), moduleRequest (a ModuleRequest Record), hostDefined (anything), and payload (a GraphLoadingState Record or a PromiseCapability Record) and returns unused.

Note 1

An example of when referrer can be a Realm Record is in a web browser host. There, if a user clicks on a control given by

<button type="button" onclick="import('./foo.mjs')">Click me</button>

there will be no active script or module at the time the import() expression runs. More generally, this can happen in any situation where the host pushes execution contexts with null ScriptOrModule components onto the execution context stack.

An implementation of HostLoadImportedModule must conform to the following requirements:

The actual process performed is host-defined, but typically consists of performing whatever I/O operations are necessary to load the appropriate Module Record. Multiple different (referrer, moduleRequest.[[Specifier]], moduleRequest.[[Attributes]]) triples may map to the same Module Record instance. The actual mapping semantics is host-defined but typically a normalization process is applied to specifier as part of the mapping process. A typical normalization process would include actions such as expansion of relative and abbreviated path specifiers.

Note 2

The above text requires that hosts support JSON modules when imported with type: "json" (and HostLoadImportedModule completes normally), but it does not prohibit hosts from supporting JSON modules when imported without type: "json".

16.2.1.11 FinishLoadingImportedModule ( referrer, moduleRequest, payload, result )

The abstract operation FinishLoadingImportedModule takes arguments referrer (a Script Record, a Cyclic Module Record, or a Realm Record), moduleRequest (a ModuleRequest Record), payload (a GraphLoadingState Record or a PromiseCapability Record), and result (either a normal completion containing a Module Record or a throw completion) and returns unused. It performs the following steps when called:

  1. If result is a normal completion, then
    1. If referrer.[[LoadedModules]] contains a LoadedModuleRequest Record record such that ModuleRequestsEqual(record, moduleRequest) is true, then
      1. Assert: record.[[Module]] and result.[[Value]] are the same Module Record.
    2. Else,
      1. Append the LoadedModuleRequest Record { [[Specifier]]: moduleRequest.[[Specifier]], [[Attributes]]: moduleRequest.[[Attributes]], [[Module]]: result.[[Value]] } to referrer.[[LoadedModules]].
  2. If payload is a GraphLoadingState Record, then
    1. Perform ContinueModuleLoading(payload, result).
  3. Else,
    1. Perform ContinueDynamicImport(payload, result).
  4. Return unused.

16.2.1.12 AllImportAttributesSupported ( attributes )

The abstract operation AllImportAttributesSupported takes argument attributes (a List of ImportAttribute Records) and returns a Boolean. It performs the following steps when called:

  1. Let supported be HostGetSupportedImportAttributes().
  2. For each ImportAttribute Record attribute of attributes, do
    1. If supported does not contain attribute.[[Key]], return false.
  3. Return true.

16.2.1.12.1 HostGetSupportedImportAttributes ( )

The host-defined abstract operation HostGetSupportedImportAttributes takes no arguments and returns a List of Strings. It allows host environments to specify which import attributes they support. Only attributes with supported keys will be provided to the host.

An implementation of HostGetSupportedImportAttributes must conform to the following requirements:

  • It must return a List of Strings, each indicating a supported attribute.
  • Each time this operation is called, it must return the same List with the same contents in the same order.

The default implementation of HostGetSupportedImportAttributes is to return a new empty List.

Note
The purpose of requiring the host to specify its supported import attributes, rather than passing all attributes to the host and letting it then choose which ones it wants to handle, is to ensure that unsupported attributes are handled in a consistent way across different hosts.

16.2.1.13 GetModuleNamespace ( module )

The abstract operation GetModuleNamespace takes argument module (an instance of a concrete subclass of Module Record) and returns a Module Namespace Object. It retrieves the Module Namespace Object representing module's exports, lazily creating it the first time it was requested, and storing it in module.[[Namespace]] for future retrieval. It performs the following steps when called:

  1. Assert: If module is a Cyclic Module Record, then module.[[Status]] is not new or unlinked.
  2. Let namespace be module.[[Namespace]].
  3. If namespace is empty, then
    1. Let exportedNames be module.GetExportedNames().
    2. Let unambiguousNames be a new empty List.
    3. For each element name of exportedNames, do
      1. Let resolution be module.ResolveExport(name).
      2. If resolution is a ResolvedBinding Record, append name to unambiguousNames.
    4. Set namespace to ModuleNamespaceCreate(module, unambiguousNames).
  4. Return namespace.
Note

GetModuleNamespace never throws. Instead, unresolvable names are simply excluded from the namespace at this point. They will lead to a real linking error later unless they are all ambiguous star exports that are not explicitly requested anywhere.

16.2.1.14 Runtime Semantics: Evaluation

Module : [empty]
  1. Return undefined.
ModuleBody : ModuleItemList
  1. Let result be Completion(Evaluation of ModuleItemList).
  2. If result is a normal completion and result.[[Value]] is empty, then
    1. Return undefined.
  3. Return ? result.
ModuleItemList : ModuleItemList ModuleItem
  1. Let sl be ? Evaluation of ModuleItemList.
  2. Let s be Completion(Evaluation of ModuleItem).
  3. Return ? UpdateEmpty(s, sl).
Note

The value of a ModuleItemList is the value of the last value-producing item in the ModuleItemList.

ModuleItem : ImportDeclaration
  1. Return empty.

16.2.2 Imports

Syntax

ImportDeclaration : import ImportClause FromClause WithClauseopt ; import ModuleSpecifier WithClauseopt ; ImportClause : ImportedDefaultBinding NameSpaceImport NamedImports ImportedDefaultBinding , NameSpaceImport ImportedDefaultBinding , NamedImports ImportedDefaultBinding : ImportedBinding NameSpaceImport : * as ImportedBinding NamedImports : { } { ImportsList } { ImportsList , } FromClause : from ModuleSpecifier ImportsList : ImportSpecifier ImportsList , ImportSpecifier ImportSpecifier : ImportedBinding ModuleExportName as ImportedBinding ModuleSpecifier : StringLiteral ImportedBinding : BindingIdentifier[~Yield, +Await] WithClause : with { } with { WithEntries ,opt } WithEntries : AttributeKey : StringLiteral AttributeKey : StringLiteral , WithEntries AttributeKey : IdentifierName StringLiteral

16.2.2.1 Static Semantics: Early Errors

ModuleItem : ImportDeclaration WithClause : with { WithEntries ,opt }

16.2.2.2 Static Semantics: ImportEntries

The syntax-directed operation ImportEntries takes no arguments and returns a List of ImportEntry Records. It is defined piecewise over the following productions:

Module : [empty]
  1. Return a new empty List.
ModuleItemList : ModuleItemList ModuleItem
  1. Let entries1 be the ImportEntries of ModuleItemList.
  2. Let entries2 be the ImportEntries of ModuleItem.
  3. Return the list-concatenation of entries1 and entries2.
ModuleItem : ExportDeclaration StatementListItem
  1. Return a new empty List.
ImportDeclaration : import ImportClause FromClause WithClauseopt ;
  1. Let module be the sole element of the ModuleRequests of ImportDeclaration.
  2. Return the ImportEntriesForModule of ImportClause with argument module.
ImportDeclaration : import ModuleSpecifier WithClauseopt ;
  1. Return a new empty List.

16.2.2.3 Static Semantics: ImportEntriesForModule

The syntax-directed operation ImportEntriesForModule takes argument module (a ModuleRequest Record) and returns a List of ImportEntry Records. It is defined piecewise over the following productions:

ImportClause : ImportedDefaultBinding , NameSpaceImport
  1. Let entries1 be the ImportEntriesForModule of ImportedDefaultBinding with argument module.
  2. Let entries2 be the ImportEntriesForModule of NameSpaceImport with argument module.
  3. Return the list-concatenation of entries1 and entries2.
ImportClause : ImportedDefaultBinding , NamedImports
  1. Let entries1 be the ImportEntriesForModule of ImportedDefaultBinding with argument module.
  2. Let entries2 be the ImportEntriesForModule of NamedImports with argument module.
  3. Return the list-concatenation of entries1 and entries2.
ImportedDefaultBinding : ImportedBinding
  1. Let localName be the sole element of the BoundNames of ImportedBinding.
  2. Let defaultEntry be the ImportEntry Record { [[ModuleRequest]]: module, [[ImportName]]: "default", [[LocalName]]: localName }.
  3. Return « defaultEntry ».
NameSpaceImport : * as ImportedBinding
  1. Let localName be the StringValue of ImportedBinding.
  2. Let entry be the ImportEntry Record { [[ModuleRequest]]: module, [[ImportName]]: namespace-object, [[LocalName]]: localName }.
  3. Return « entry ».
NamedImports : { }
  1. Return a new empty List.
ImportsList : ImportsList , ImportSpecifier
  1. Let specs1 be the ImportEntriesForModule of ImportsList with argument module.
  2. Let specs2 be the ImportEntriesForModule of ImportSpecifier with argument module.
  3. Return the list-concatenation of specs1 and specs2.
ImportSpecifier : ImportedBinding
  1. Let localName be the sole element of the BoundNames of ImportedBinding.
  2. Let entry be the ImportEntry Record { [[ModuleRequest]]: module, [[ImportName]]: localName, [[LocalName]]: localName }.
  3. Return « entry ».
ImportSpecifier : ModuleExportName as ImportedBinding
  1. Let importName be the StringValue of ModuleExportName.
  2. Let localName be the StringValue of ImportedBinding.
  3. Let entry be the ImportEntry Record { [[ModuleRequest]]: module, [[ImportName]]: importName, [[LocalName]]: localName }.
  4. Return « entry ».

16.2.2.4 Static Semantics: WithClauseToAttributes

The syntax-directed operation WithClauseToAttributes takes no arguments and returns a List of ImportAttribute Records. It is defined piecewise over the following productions:

WithClause : with { }
  1. Return a new empty List.
WithClause : with { WithEntries ,opt }
  1. Let attributes be WithClauseToAttributes of WithEntries.
  2. Sort attributes according to the lexicographic order of their [[Key]] field, treating the value of each such field as a sequence of UTF-16 code unit values. NOTE: This sorting is observable only in that hosts are prohibited from changing behaviour based on the order in which attributes are enumerated.
  3. Return attributes.
WithEntries : AttributeKey : StringLiteral
  1. Let key be the PropName of AttributeKey.
  2. Let entry be the ImportAttribute Record { [[Key]]: key, [[Value]]: the SV of StringLiteral }.
  3. Return « entry ».
WithEntries : AttributeKey : StringLiteral , WithEntries
  1. Let key be the PropName of AttributeKey.
  2. Let entry be the ImportAttribute Record { [[Key]]: key, [[Value]]: the SV of StringLiteral }.
  3. Let rest be WithClauseToAttributes of WithEntries.
  4. Return the list-concatenation of « entry » and rest.

16.2.3 Exports

Syntax

ExportDeclaration : export ExportFromClause FromClause WithClauseopt ; export NamedExports ; export VariableStatement[~Yield, +Await] export Declaration[~Yield, +Await] export default HoistableDeclaration[~Yield, +Await, +Default] export default ClassDeclaration[~Yield, +Await, +Default] export default [lookahead ∉ { function, async [no LineTerminator here] function, class }] AssignmentExpression[+In, ~Yield, +Await] ; ExportFromClause : * * as ModuleExportName NamedExports NamedExports : { } { ExportsList } { ExportsList , } ExportsList : ExportSpecifier ExportsList , ExportSpecifier ExportSpecifier : ModuleExportName ModuleExportName as ModuleExportName

16.2.3.1 Static Semantics: Early Errors

ExportDeclaration : export NamedExports ; Note

The above rule means that each ReferencedBindings of NamedExports is treated as an IdentifierReference.

16.2.3.2 Static Semantics: ExportedBindings

The syntax-directed operation ExportedBindings takes no arguments and returns a List of Strings.

Note

ExportedBindings are the locally bound names that are explicitly associated with a Module's ExportedNames.

It is defined piecewise over the following productions:

ModuleItemList : ModuleItemList ModuleItem
  1. Let names1 be the ExportedBindings of ModuleItemList.
  2. Let names2 be the ExportedBindings of ModuleItem.
  3. Return the list-concatenation of names1 and names2.
ModuleItem : ImportDeclaration StatementListItem
  1. Return a new empty List.
ExportDeclaration : export ExportFromClause FromClause WithClauseopt ;
  1. Return a new empty List.
ExportDeclaration : export NamedExports ;
  1. Return the ExportedBindings of NamedExports.
ExportDeclaration : export VariableStatement
  1. Return the BoundNames of VariableStatement.
ExportDeclaration : export Declaration
  1. Return the BoundNames of Declaration.
ExportDeclaration : export default HoistableDeclaration export default ClassDeclaration export default AssignmentExpression ;
  1. Return the BoundNames of this ExportDeclaration.
NamedExports : { }
  1. Return a new empty List.
ExportsList : ExportsList , ExportSpecifier
  1. Let names1 be the ExportedBindings of ExportsList.
  2. Let names2 be the ExportedBindings of ExportSpecifier.
  3. Return the list-concatenation of names1 and names2.
ExportSpecifier : ModuleExportName
  1. Return a List whose sole element is the StringValue of ModuleExportName.
ExportSpecifier : ModuleExportName as ModuleExportName
  1. Return a List whose sole element is the StringValue of the first ModuleExportName.

16.2.3.3 Static Semantics: ExportedNames

The syntax-directed operation ExportedNames takes no arguments and returns a List of Strings.

Note

ExportedNames are the externally visible names that a Module explicitly maps to one of its local name bindings.

It is defined piecewise over the following productions:

ModuleItemList : ModuleItemList ModuleItem
  1. Let names1 be the ExportedNames of ModuleItemList.
  2. Let names2 be the ExportedNames of ModuleItem.
  3. Return the list-concatenation of names1 and names2.
ModuleItem : ExportDeclaration
  1. Return the ExportedNames of ExportDeclaration.
ModuleItem : ImportDeclaration StatementListItem
  1. Return a new empty List.
ExportDeclaration : export ExportFromClause FromClause WithClauseopt ;
  1. Return the ExportedNames of ExportFromClause.
ExportFromClause : *
  1. Return a new empty List.
ExportFromClause : * as ModuleExportName
  1. Return a List whose sole element is the StringValue of ModuleExportName.
ExportFromClause : NamedExports
  1. Return the ExportedNames of NamedExports.
ExportDeclaration : export VariableStatement
  1. Return the BoundNames of VariableStatement.
ExportDeclaration : export Declaration
  1. Return the BoundNames of Declaration.
ExportDeclaration : export default HoistableDeclaration export default ClassDeclaration export default AssignmentExpression ;
  1. Return « "default" ».
NamedExports : { }
  1. Return a new empty List.
ExportsList : ExportsList , ExportSpecifier
  1. Let names1 be the ExportedNames of ExportsList.
  2. Let names2 be the ExportedNames of ExportSpecifier.
  3. Return the list-concatenation of names1 and names2.
ExportSpecifier : ModuleExportName
  1. Return a List whose sole element is the StringValue of ModuleExportName.
ExportSpecifier : ModuleExportName as ModuleExportName
  1. Return a List whose sole element is the StringValue of the second ModuleExportName.

16.2.3.4 Static Semantics: ExportEntries

The syntax-directed operation ExportEntries takes no arguments and returns a List of ExportEntry Records. It is defined piecewise over the following productions:

Module : [empty]
  1. Return a new empty List.
ModuleItemList : ModuleItemList ModuleItem
  1. Let entries1 be the ExportEntries of ModuleItemList.
  2. Let entries2 be the ExportEntries of ModuleItem.
  3. Return the list-concatenation of entries1 and entries2.
ModuleItem : ImportDeclaration StatementListItem
  1. Return a new empty List.
ExportDeclaration : export ExportFromClause FromClause WithClauseopt ;
  1. Let module be the sole element of the ModuleRequests of ExportDeclaration.
  2. Return the ExportEntriesForModule of ExportFromClause with argument module.
ExportDeclaration : export NamedExports ;
  1. Return the ExportEntriesForModule of NamedExports with argument null.
ExportDeclaration : export VariableStatement
  1. Let entries be a new empty List.
  2. Let names be the BoundNames of VariableStatement.
  3. For each element name of names, do
    1. Append the ExportEntry Record { [[ModuleRequest]]: null, [[ImportName]]: null, [[LocalName]]: name, [[ExportName]]: name } to entries.
  4. Return entries.
ExportDeclaration : export Declaration
  1. Let entries be a new empty List.
  2. Let names be the BoundNames of Declaration.
  3. For each element name of names, do
    1. Append the ExportEntry Record { [[ModuleRequest]]: null, [[ImportName]]: null, [[LocalName]]: name, [[ExportName]]: name } to entries.
  4. Return entries.
ExportDeclaration : export default HoistableDeclaration
  1. Let names be the BoundNames of HoistableDeclaration.
  2. Let localName be the sole element of names.
  3. Return a List whose sole element is a new ExportEntry Record { [[ModuleRequest]]: null, [[ImportName]]: null, [[LocalName]]: localName, [[ExportName]]: "default" }.
ExportDeclaration : export default ClassDeclaration
  1. Let names be the BoundNames of ClassDeclaration.
  2. Let localName be the sole element of names.
  3. Return a List whose sole element is a new ExportEntry Record { [[ModuleRequest]]: null, [[ImportName]]: null, [[LocalName]]: localName, [[ExportName]]: "default" }.
ExportDeclaration : export default AssignmentExpression ;
  1. Let entry be the ExportEntry Record { [[ModuleRequest]]: null, [[ImportName]]: null, [[LocalName]]: "*default*", [[ExportName]]: "default" }.
  2. Return « entry ».
Note

"*default*" is used within this specification as a synthetic name for anonymous default export values. See this note for more details.

16.2.3.5 Static Semantics: ExportEntriesForModule

The syntax-directed operation ExportEntriesForModule takes argument module (a ModuleRequest Record or null) and returns a List of ExportEntry Records. It is defined piecewise over the following productions:

ExportFromClause : *
  1. Let entry be the ExportEntry Record { [[ModuleRequest]]: module, [[ImportName]]: all-but-default, [[LocalName]]: null, [[ExportName]]: null }.
  2. Return « entry ».
ExportFromClause : * as ModuleExportName
  1. Let exportName be the StringValue of ModuleExportName.
  2. Let entry be the ExportEntry Record { [[ModuleRequest]]: module, [[ImportName]]: all, [[LocalName]]: null, [[ExportName]]: exportName }.
  3. Return « entry ».
NamedExports : { }
  1. Return a new empty List.
ExportsList : ExportsList , ExportSpecifier
  1. Let specs1 be the ExportEntriesForModule of ExportsList with argument module.
  2. Let specs2 be the ExportEntriesForModule of ExportSpecifier with argument module.
  3. Return the list-concatenation of specs1 and specs2.
ExportSpecifier : ModuleExportName
  1. Let sourceName be the StringValue of ModuleExportName.
  2. If module is null, then
    1. Let localName be sourceName.
    2. Let importName be null.
  3. Else,
    1. Let localName be null.
    2. Let importName be sourceName.
  4. Return a List whose sole element is a new ExportEntry Record { [[ModuleRequest]]: module, [[ImportName]]: importName, [[LocalName]]: localName, [[ExportName]]: sourceName }.
ExportSpecifier : ModuleExportName as ModuleExportName
  1. Let sourceName be the StringValue of the first ModuleExportName.
  2. Let exportName be the StringValue of the second ModuleExportName.
  3. If module is null, then
    1. Let localName be sourceName.
    2. Let importName be null.
  4. Else,
    1. Let localName be null.
    2. Let importName be sourceName.
  5. Return a List whose sole element is a new ExportEntry Record { [[ModuleRequest]]: module, [[ImportName]]: importName, [[LocalName]]: localName, [[ExportName]]: exportName }.

16.2.3.6 Static Semantics: ReferencedBindings

The syntax-directed operation ReferencedBindings takes no arguments and returns a List of Parse Nodes. It is defined piecewise over the following productions:

NamedExports : { }
  1. Return a new empty List.
ExportsList : ExportsList , ExportSpecifier
  1. Let names1 be the ReferencedBindings of ExportsList.
  2. Let names2 be the ReferencedBindings of ExportSpecifier.
  3. Return the list-concatenation of names1 and names2.
ExportSpecifier : ModuleExportName as ModuleExportName
  1. Return the ReferencedBindings of the first ModuleExportName.
ModuleExportName : IdentifierName
  1. Return a List whose sole element is the IdentifierName.
ModuleExportName : StringLiteral
  1. Return a List whose sole element is the StringLiteral.

16.2.3.7 Runtime Semantics: Evaluation

ExportDeclaration : export ExportFromClause FromClause WithClauseopt ; export NamedExports ;
  1. Return empty.
ExportDeclaration : export VariableStatement
  1. Return ? Evaluation of VariableStatement.
ExportDeclaration : export Declaration
  1. Return ? Evaluation of Declaration.
ExportDeclaration : export default HoistableDeclaration
  1. Return ? Evaluation of HoistableDeclaration.
ExportDeclaration : export default ClassDeclaration
  1. Let value be ? BindingClassDeclarationEvaluation of ClassDeclaration.
  2. Let className be the sole element of the BoundNames of ClassDeclaration.
  3. If className is "*default*", then
    1. Let env be the running execution context's LexicalEnvironment.
    2. Perform ? InitializeBoundName("*default*", value, env).
  4. Return empty.
ExportDeclaration : export default AssignmentExpression ;
  1. If IsAnonymousFunctionDefinition(AssignmentExpression) is true, then
    1. Let value be ? NamedEvaluation of AssignmentExpression with argument "default".
  2. Else,
    1. Let rhs be ? Evaluation of AssignmentExpression.
    2. Let value be ? GetValue(rhs).
  3. Let env be the running execution context's LexicalEnvironment.
  4. Perform ? InitializeBoundName("*default*", value, env).
  5. Return empty.

17 Error Handling and Language Extensions

An implementation must report most errors at the time the relevant ECMAScript language construct is evaluated. An early error is an error that can be detected and reported prior to the evaluation of any construct in the Script containing the error. The presence of an early error prevents the evaluation of the construct. An implementation must report early errors in a Script as part of parsing that Script in ParseScript. Early errors in a Module are reported at the point when the Module would be evaluated and the Module is never initialized. Early errors in eval code are reported at the time eval is called and prevent evaluation of the eval code. All errors that are not early errors are runtime errors.

An implementation must report as an early error any occurrence of a condition that is listed in a “Static Semantics: Early Errors” subclause of this specification.

An implementation shall not treat other kinds of errors as early errors even if the compiler can prove that a construct cannot execute without error under any circumstances. An implementation may issue an early warning in such a case, but it should not report the error until the relevant construct is actually executed.

An implementation shall report all errors as specified, except for the following:

17.1 Forbidden Extensions

An implementation must not extend this specification in the following ways:

18 ECMAScript Standard Built-in Objects

There are certain built-in objects available whenever an ECMAScript Script or Module begins execution. One, the global object, is part of the global environment of the executing program. Others are accessible as initial properties of the global object or indirectly as properties of accessible built-in objects.

Unless specified otherwise, a built-in object that is callable as a function is a built-in function object with the characteristics described in 10.3. Unless specified otherwise, the [[Extensible]] internal slot of a built-in object initially has the value true. Every built-in function object has a [[Realm]] internal slot whose value is the Realm Record of the realm for which the object was initially created.

Many built-in objects are functions: they can be invoked with arguments. Some of them furthermore are constructors: they are functions intended for use with the new operator. For each built-in function, this specification describes the arguments required by that function and the properties of that function object. For each built-in constructor, this specification furthermore describes properties of the prototype object of that constructor and properties of specific object instances returned by a new expression that invokes that constructor.

Unless otherwise specified in the description of a particular function, if a built-in function or constructor is given fewer arguments than the function is specified to require, the function or constructor shall behave exactly as if it had been given sufficient additional arguments, each such argument being the undefined value. Such missing arguments are considered to be “not present” and may be identified in that manner by specification algorithms. In the description of a particular function, the terms “this value” and “NewTarget” have the meanings given in 10.3.

Unless otherwise specified in the description of a particular function, if a built-in function or constructor described is given more arguments than the function is specified to allow, the extra arguments are evaluated by the call and then ignored by the function. However, an implementation may define implementation specific behaviour relating to such arguments as long as the behaviour is not the throwing of a TypeError exception that is predicated simply on the presence of an extra argument.

Note 1

Implementations that add additional capabilities to the set of built-in functions are encouraged to do so by adding new functions rather than adding new parameters to existing functions.

Unless otherwise specified every built-in function and every built-in constructor has the Function prototype object, which is the initial value of the expression Function.prototype (20.2.3), as the value of its [[Prototype]] internal slot.

Unless otherwise specified every built-in prototype object has the Object prototype object, which is the initial value of the expression Object.prototype (20.1.3), as the value of its [[Prototype]] internal slot, except the Object prototype object itself.

If this specification defines a built-in constructor's behaviour via algorithm steps, then that is its behaviour for the purposes of both [[Call]] and [[Construct]]. If such an algorithm needs to distinguish the two cases, it checks whether NewTarget is undefined, which indicates a [[Call]] invocation.

Built-in function objects that are not identified as constructors do not implement the [[Construct]] internal method unless otherwise specified in the description of a particular function.

Built-in function objects that are not constructors do not have a "prototype" property unless otherwise specified in the description of a particular function.

Each built-in function defined in this specification is created by calling the CreateBuiltinFunction abstract operation (10.3.4). The values of the length and name parameters are the initial values of the "length" and "name" properties as discussed below. The values of the prefix parameter are similarly discussed below.

Every built-in function object, including constructors, has a "length" property whose value is a non-negative integral Number. Unless otherwise specified, this value is the number of required parameters shown in the subclause heading for the function description. Optional parameters and rest parameters are not included in the parameter count.

Note 2

For example, the function object that is the initial value of the "map" property of the Array prototype object is described under the subclause heading «Array.prototype.map (callback [ , thisArg])» which shows the two named arguments callback and thisArg, the latter being optional; therefore the value of the "length" property of that function object is 1𝔽.

Unless otherwise specified, the "length" property of a built-in function object has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: true }.

Every built-in function object, including constructors, has a "name" property whose value is a String. Unless otherwise specified, this value is the name that is given to the function in this specification. Functions that are identified as anonymous functions use the empty String as the value of the "name" property. For functions that are specified as properties of objects, the name value is the property name string used to access the function. Functions that are specified as get or set accessor functions of built-in properties have "get" or "set" (respectively) passed to the prefix parameter when calling CreateBuiltinFunction.

The value of the "name" property is explicitly specified for each built-in functions whose property key is a Symbol value. If such an explicitly specified value starts with the prefix "get " or "set " and the function for which it is specified is a get or set accessor function of a built-in property, the value without the prefix is passed to the name parameter, and the value "get" or "set" (respectively) is passed to the prefix parameter when calling CreateBuiltinFunction.

Unless otherwise specified, the "name" property of a built-in function object has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: true }.

Every other data property described in clauses 19 through 28 and in Annex B.2 has the attributes { [[Writable]]: true, [[Enumerable]]: false, [[Configurable]]: true } unless otherwise specified.

Every accessor property described in clauses 19 through 28 and in Annex B.2 has the attributes { [[Enumerable]]: false, [[Configurable]]: true } unless otherwise specified. If only a get accessor function is described, the set accessor function is the default value, undefined. If only a set accessor is described the get accessor is the default value, undefined.

19 The Global Object

The global object:

19.1 Value Properties of the Global Object

19.1.1 globalThis

The initial value of the "globalThis" property of the global object in a Realm Record realm is realm.[[GlobalEnv]].[[GlobalThisValue]].

This property has the attributes { [[Writable]]: true, [[Enumerable]]: false, [[Configurable]]: true }.

19.1.2 Infinity

The value of Infinity is +∞𝔽 (see 6.1.6.1). This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: false }.

19.1.3 NaN

The value of NaN is NaN (see 6.1.6.1). This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: false }.

19.1.4 undefined

The value of undefined is undefined (see 6.1.1). This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: false }.

19.2 Function Properties of the Global Object

19.2.1 eval ( x )

This function is the %eval% intrinsic object.

It performs the following steps when called:

  1. Return ? PerformEval(x, false, false).

19.2.1.1 PerformEval ( x, strictCaller, direct )

The abstract operation PerformEval takes arguments x (an ECMAScript language value), strictCaller (a Boolean), and direct (a Boolean) and returns either a normal completion containing an ECMAScript language value or a throw completion. It performs the following steps when called:

  1. Assert: If direct is false, then strictCaller is also false.
  2. If x is not a String, return x.
  3. Let evalRealm be the current Realm Record.
  4. NOTE: In the case of a direct eval, evalRealm is the realm of both the caller of eval and of the eval function itself.
  5. Perform ? HostEnsureCanCompileStrings(evalRealm, « », x, direct).
  6. Let inFunction be false.
  7. Let inMethod be false.
  8. Let inDerivedConstructor be false.
  9. Let inClassFieldInitializer be false.
  10. If direct is true, then
    1. Let thisEnvRec be GetThisEnvironment().
    2. If thisEnvRec is a Function Environment Record, then
      1. Let F be thisEnvRec.[[FunctionObject]].
      2. Set inFunction to true.
      3. Set inMethod to thisEnvRec.HasSuperBinding().
      4. If F.[[ConstructorKind]] is derived, set inDerivedConstructor to true.
      5. Let classFieldInitializerName be F.[[ClassFieldInitializerName]].
      6. If classFieldInitializerName is not empty, set inClassFieldInitializer to true.
  11. Perform the following substeps in an implementation-defined order, possibly interleaving parsing and error detection:
    1. Let script be ParseText(x, Script).
    2. If script is a List of errors, throw a SyntaxError exception.
    3. If script Contains ScriptBody is false, return undefined.
    4. Let body be the ScriptBody of script.
    5. If inFunction is false and body Contains NewTarget, throw a SyntaxError exception.
    6. If inMethod is false and body Contains SuperProperty, throw a SyntaxError exception.
    7. If inDerivedConstructor is false and body Contains SuperCall, throw a SyntaxError exception.
    8. If inClassFieldInitializer is true and ContainsArguments of body is true, throw a SyntaxError exception.
  12. If strictCaller is true, let strictEval be true.
  13. Else, let strictEval be ScriptIsStrict of script.
  14. Let runningContext be the running execution context.
  15. NOTE: If direct is true, runningContext will be the execution context that performed the direct eval. If direct is false, runningContext will be the execution context for the invocation of the eval function.
  16. If direct is true, then
    1. Let lexEnv be NewDeclarativeEnvironment(runningContext's LexicalEnvironment).
    2. Let varEnv be runningContext's VariableEnvironment.
    3. Let privateEnv be runningContext's PrivateEnvironment.
  17. Else,
    1. Let lexEnv be NewDeclarativeEnvironment(evalRealm.[[GlobalEnv]]).
    2. Let varEnv be evalRealm.[[GlobalEnv]].
    3. Let privateEnv be null.
  18. If strictEval is true, set varEnv to lexEnv.
  19. If runningContext is not already suspended, suspend runningContext.
  20. Let evalContext be a new ECMAScript code execution context.
  21. Set evalContext's Function to null.
  22. Set evalContext's Realm to evalRealm.
  23. Set evalContext's ScriptOrModule to runningContext's ScriptOrModule.
  24. Set evalContext's VariableEnvironment to varEnv.
  25. Set evalContext's LexicalEnvironment to lexEnv.
  26. Set evalContext's PrivateEnvironment to privateEnv.
  27. Push evalContext onto the execution context stack; evalContext is now the running execution context.
  28. Let result be Completion(EvalDeclarationInstantiation(body, varEnv, lexEnv, privateEnv, strictEval)).
  29. If result is a normal completion, then
    1. Set result to Completion(Evaluation of body).
  30. If result is a normal completion and result.[[Value]] is empty, then
    1. Set result to NormalCompletion(undefined).
  31. Suspend evalContext and remove it from the execution context stack.
  32. Resume the context that is now on the top of the execution context stack as the running execution context.
  33. Return ? result.
Note

The eval code cannot instantiate variable or function bindings in the variable environment of the calling context that invoked the eval if either the code of the calling context or the eval code is strict mode code. Instead such bindings are instantiated in a new VariableEnvironment that is only accessible to the eval code. Bindings introduced by let, const, or class declarations are always instantiated in a new LexicalEnvironment.

19.2.1.2 HostEnsureCanCompileStrings ( calleeRealm, parameterStrings, bodyString, direct )

The host-defined abstract operation HostEnsureCanCompileStrings takes arguments calleeRealm (a Realm Record), parameterStrings (a List of Strings), bodyString (a String), and direct (a Boolean) and returns either a normal completion containing unused or a throw completion. It allows host environments to block certain ECMAScript functions which allow developers to interpret and evaluate strings as ECMAScript code.

parameterStrings represents the strings that, when using one of the function constructors, will be concatenated together to build the parameters list. bodyString represents the function body or the string passed to an eval call. direct signifies whether the evaluation is a direct eval.

The default implementation of HostEnsureCanCompileStrings is to return NormalCompletion(unused).

19.2.1.3 EvalDeclarationInstantiation ( body, varEnv, lexEnv, privateEnv, strict )

The abstract operation EvalDeclarationInstantiation takes arguments body (a ScriptBody Parse Node), varEnv (an Environment Record), lexEnv (a Declarative Environment Record), privateEnv (a PrivateEnvironment Record or null), and strict (a Boolean) and returns either a normal completion containing unused or a throw completion. It performs the following steps when called:

  1. Let varNames be the VarDeclaredNames of body.
  2. Let varDeclarations be the VarScopedDeclarations of body.
  3. If strict is false, then
    1. If varEnv is a Global Environment Record, then
      1. For each element name of varNames, do
        1. If HasLexicalDeclaration(varEnv, name) is true, throw a SyntaxError exception.
        2. NOTE: eval will not create a global var declaration that would be shadowed by a global lexical declaration.
    2. Let thisEnv be lexEnv.
    3. Assert: The following loop will terminate.
    4. Repeat, while thisEnv and varEnv are not the same Environment Record,
      1. If thisEnv is not an Object Environment Record, then
        1. NOTE: The environment of with statements cannot contain any lexical declaration so it doesn't need to be checked for var/let hoisting conflicts.
        2. For each element name of varNames, do
          1. If ! thisEnv.HasBinding(name) is true, then
            1. Throw a SyntaxError exception.
            2. NOTE: Annex B.3.4 defines alternate semantics for the above step.
          2. NOTE: A direct eval will not hoist var declaration over a like-named lexical declaration.
      2. Set thisEnv to thisEnv.[[OuterEnv]].
  4. Let privateIdentifiers be a new empty List.
  5. Let pointer be privateEnv.
  6. Repeat, while pointer is not null,
    1. For each Private Name binding of pointer.[[Names]], do
      1. If privateIdentifiers does not contain binding.[[Description]], append binding.[[Description]] to privateIdentifiers.
    2. Set pointer to pointer.[[OuterPrivateEnvironment]].
  7. If AllPrivateIdentifiersValid of body with argument privateIdentifiers is false, throw a SyntaxError exception.
  8. Let functionsToInitialize be a new empty List.
  9. Let declaredFunctionNames be a new empty List.
  10. For each element d of varDeclarations, in reverse List order, do
    1. If d is not either a VariableDeclaration, a ForBinding, or a BindingIdentifier, then
      1. Assert: d is either a FunctionDeclaration, a GeneratorDeclaration, an AsyncFunctionDeclaration, or an AsyncGeneratorDeclaration.
      2. NOTE: If there are multiple function declarations for the same name, the last declaration is used.
      3. Let fn be the sole element of the BoundNames of d.
      4. If declaredFunctionNames does not contain fn, then
        1. If varEnv is a Global Environment Record, then
          1. Let fnDefinable be ? CanDeclareGlobalFunction(varEnv, fn).
          2. If fnDefinable is false, throw a TypeError exception.
        2. Append fn to declaredFunctionNames.
        3. Insert d as the first element of functionsToInitialize.
  11. Let declaredVarNames be a new empty List.
  12. For each element d of varDeclarations, do
    1. If d is either a VariableDeclaration, a ForBinding, or a BindingIdentifier, then
      1. For each String vn of the BoundNames of d, do
        1. If declaredFunctionNames does not contain vn, then
          1. If varEnv is a Global Environment Record, then
            1. Let vnDefinable be ? CanDeclareGlobalVar(varEnv, vn).
            2. If vnDefinable is false, throw a TypeError exception.
          2. If declaredVarNames does not contain vn, then
            1. Append vn to declaredVarNames.
  13. NOTE: Annex B.3.2.3 adds additional steps at this point.
  14. NOTE: No abnormal terminations occur after this algorithm step unless varEnv is a Global Environment Record and the global object is a Proxy exotic object.
  15. Let lexDeclarations be the LexicallyScopedDeclarations of body.
  16. For each element d of lexDeclarations, do
    1. NOTE: Lexically declared names are only instantiated here but not initialized.
    2. For each element dn of the BoundNames of d, do
      1. If IsConstantDeclaration of d is true, then
        1. Perform ? lexEnv.CreateImmutableBinding(dn, true).
      2. Else,
        1. Perform ? lexEnv.CreateMutableBinding(dn, false).
  17. For each Parse Node f of functionsToInitialize, do
    1. Let fn be the sole element of the BoundNames of f.
    2. Let fo be InstantiateFunctionObject of f with arguments lexEnv and privateEnv.
    3. If varEnv is a Global Environment Record, then
      1. Perform ? CreateGlobalFunctionBinding(varEnv, fn, fo, true).
    4. Else,
      1. Let bindingExists be ! varEnv.HasBinding(fn).
      2. If bindingExists is false, then
        1. NOTE: The following invocation cannot return an abrupt completion because of the validation preceding step 14.
        2. Perform ! varEnv.CreateMutableBinding(fn, true).
        3. Perform ! varEnv.InitializeBinding(fn, fo).
      3. Else,
        1. Perform ! varEnv.SetMutableBinding(fn, fo, false).
  18. For each String vn of declaredVarNames, do
    1. If varEnv is a Global Environment Record, then
      1. Perform ? CreateGlobalVarBinding(varEnv, vn, true).
    2. Else,
      1. Let bindingExists be ! varEnv.HasBinding(vn).
      2. If bindingExists is false, then
        1. NOTE: The following invocation cannot return an abrupt completion because of the validation preceding step 14.
        2. Perform ! varEnv.CreateMutableBinding(vn, true).
        3. Perform ! varEnv.InitializeBinding(vn, undefined).
  19. Return unused.
Note

An alternative version of this algorithm is described in B.3.4.

19.2.2 isFinite ( number )

This function is the %isFinite% intrinsic object.

It performs the following steps when called:

  1. Let num be ? ToNumber(number).
  2. If num is not finite, return false.
  3. Otherwise, return true.

19.2.3 isNaN ( number )

This function is the %isNaN% intrinsic object.

It performs the following steps when called:

  1. Let num be ? ToNumber(number).
  2. If num is NaN, return true.
  3. Otherwise, return false.
Note

A reliable way for ECMAScript code to test if a value X is NaN is an expression of the form X !== X. The result will be true if and only if X is NaN.

19.2.4 parseFloat ( string )

This function produces a Number value dictated by interpretation of the contents of the string argument as a decimal literal.

It is the %parseFloat% intrinsic object.

It performs the following steps when called:

  1. Let inputString be ? ToString(string).
  2. Let trimmedString be ! TrimString(inputString, start).
  3. Let trimmed be StringToCodePoints(trimmedString).
  4. Let trimmedPrefix be the longest prefix of trimmed that satisfies the syntax of a StrDecimalLiteral, which might be trimmed itself. If there is no such prefix, return NaN.
  5. Let parsedNumber be ParseText(trimmedPrefix, StrDecimalLiteral).
  6. Assert: parsedNumber is a Parse Node.
  7. Return the StringNumericValue of parsedNumber.
Note

This function may interpret only a leading portion of string as a Number value; it ignores any code units that cannot be interpreted as part of the notation of a decimal literal, and no indication is given that any such code units were ignored.

19.2.5 parseInt ( string, radix )

This function produces an integral Number dictated by interpretation of the contents of string according to the specified radix. Leading white space in string is ignored. If radix coerces to 0 (such as when it is undefined), it is assumed to be 10 except when the number representation begins with "0x" or "0X", in which case it is assumed to be 16. If radix is 16, the number representation may optionally begin with "0x" or "0X".

It is the %parseInt% intrinsic object.

It performs the following steps when called:

  1. Let inputString be ? ToString(string).
  2. Let S be ! TrimString(inputString, start).
  3. Let sign be 1.
  4. If S is not empty and the first code unit of S is the code unit 0x002D (HYPHEN-MINUS), set sign to -1.
  5. If S is not empty and the first code unit of S is either the code unit 0x002B (PLUS SIGN) or the code unit 0x002D (HYPHEN-MINUS), set S to the substring of S from index 1.
  6. Let R be (? ToInt32(radix)).
  7. Let stripPrefix be true.
  8. If R ≠ 0, then
    1. If R < 2 or R > 36, return NaN.
    2. If R ≠ 16, set stripPrefix to false.
  9. Else,
    1. Set R to 10.
  10. If stripPrefix is true, then
    1. If the length of S is at least 2 and the first two code units of S are either "0x" or "0X", then
      1. Set S to the substring of S from index 2.
      2. Set R to 16.
  11. If S contains a code unit that is not a radix-R digit, let end be the index within S of the first such code unit; otherwise let end be the length of S.
  12. Let Z be the substring of S from 0 to end.
  13. If Z is empty, return NaN.
  14. Let mathInt be the integer value that is represented by Z in radix-R notation, using the letters A through Z and a through z for digits with values 10 through 35. (However, if R = 10 and Z contains more than 20 significant digits, every significant digit after the 20th may be replaced by a 0 digit, at the option of the implementation; and if R is not one of 2, 4, 8, 10, 16, or 32, then mathInt may be an implementation-approximated integer representing the integer value denoted by Z in radix-R notation.)
  15. If mathInt = 0, then
    1. If sign = -1, return -0𝔽.
    2. Return +0𝔽.
  16. Return 𝔽(sign × mathInt).
Note

This function may interpret only a leading portion of string as an integer value; it ignores any code units that cannot be interpreted as part of the notation of an integer, and no indication is given that any such code units were ignored.

19.2.6 URI Handling Functions

Uniform Resource Identifiers, or URIs, are Strings that identify resources (e.g. web pages or files) and transport protocols by which to access them (e.g. HTTP or FTP) on the Internet. The ECMAScript language itself does not provide any support for using URIs except for functions that encode and decode URIs as described in this section. encodeURI and decodeURI are intended to work with complete URIs; they assume that any reserved characters are intended to have special meaning (e.g., as delimiters) and so are not encoded. encodeURIComponent and decodeURIComponent are intended to work with the individual components of a URI; they assume that any reserved characters represent text and must be encoded to avoid special meaning when the component is part of a complete URI.

Note 1

The set of reserved characters is based upon RFC 2396 and does not reflect changes introduced by the more recent RFC 3986.

Note 2

Many implementations of ECMAScript provide additional functions and methods that manipulate web pages; these functions are beyond the scope of this standard.

19.2.6.1 decodeURI ( encodedURI )

This function computes a new version of a URI in which each escape sequence and UTF-8 encoding of the sort that might be introduced by the encodeURI function is replaced with the UTF-16 encoding of the code point that it represents. Escape sequences that could not have been introduced by encodeURI are not replaced.

It is the %decodeURI% intrinsic object.

It performs the following steps when called:

  1. Let uriString be ? ToString(encodedURI).
  2. Let preserveEscapeSet be ";/?:@&=+$,#".
  3. Return ? Decode(uriString, preserveEscapeSet).

19.2.6.2 decodeURIComponent ( encodedURIComponent )

This function computes a new version of a URI in which each escape sequence and UTF-8 encoding of the sort that might be introduced by the encodeURIComponent function is replaced with the UTF-16 encoding of the code point that it represents.

It is the %decodeURIComponent% intrinsic object.

It performs the following steps when called:

  1. Let componentString be ? ToString(encodedURIComponent).
  2. Let preserveEscapeSet be the empty String.
  3. Return ? Decode(componentString, preserveEscapeSet).

19.2.6.3 encodeURI ( uri )

This function computes a new version of a UTF-16 encoded (6.1.4) URI in which each instance of certain code points is replaced by one, two, three, or four escape sequences representing the UTF-8 encoding of the code point.

It is the %encodeURI% intrinsic object.

It performs the following steps when called:

  1. Let uriString be ? ToString(uri).
  2. Let extraUnescaped be ";/?:@&=+$,#".
  3. Return ? Encode(uriString, extraUnescaped).

19.2.6.4 encodeURIComponent ( uriComponent )

This function computes a new version of a UTF-16 encoded (6.1.4) URI in which each instance of certain code points is replaced by one, two, three, or four escape sequences representing the UTF-8 encoding of the code point.

It is the %encodeURIComponent% intrinsic object.

It performs the following steps when called:

  1. Let componentString be ? ToString(uriComponent).
  2. Let extraUnescaped be the empty String.
  3. Return ? Encode(componentString, extraUnescaped).

19.2.6.5 Encode ( string, extraUnescaped )

The abstract operation Encode takes arguments string (a String) and extraUnescaped (a String) and returns either a normal completion containing a String or a throw completion. It performs URI encoding and escaping, interpreting string as a sequence of UTF-16 encoded code points as described in 6.1.4. If a character is identified as unreserved in RFC 2396 or appears in extraUnescaped, it is not escaped. It performs the following steps when called:

  1. Let len be the length of string.
  2. Let R be the empty String.
  3. Let alwaysUnescaped be the string-concatenation of the ASCII word characters and "-.!~*'()".
  4. Let unescapedSet be the string-concatenation of alwaysUnescaped and extraUnescaped.
  5. Let k be 0.
  6. Repeat, while k < len,
    1. Let C be the code unit at index k within string.
    2. If unescapedSet contains C, then
      1. Set k to k + 1.
      2. Set R to the string-concatenation of R and C.
    3. Else,
      1. Let cp be CodePointAt(string, k).
      2. If cp.[[IsUnpairedSurrogate]] is true, throw a URIError exception.
      3. Set k to k + cp.[[CodeUnitCount]].
      4. Let Octets be the List of octets resulting by applying the UTF-8 transformation to cp.[[CodePoint]].
      5. For each element octet of Octets, do
        1. Let hex be the String representation of octet, formatted as an uppercase hexadecimal number.
        2. Set R to the string-concatenation of R, "%", and StringPad(hex, 2, "0", start).
  7. Return R.
Note

Because percent-encoding is used to represent individual octets, a single code point may be expressed as multiple consecutive escape sequences (one for each of its 8-bit UTF-8 code units).

19.2.6.6 Decode ( string, preserveEscapeSet )

The abstract operation Decode takes arguments string (a String) and preserveEscapeSet (a String) and returns either a normal completion containing a String or a throw completion. It performs URI unescaping and decoding, preserving any escape sequences that correspond to Basic Latin characters in preserveEscapeSet. It performs the following steps when called:

  1. Let len be the length of string.
  2. Let R be the empty String.
  3. Let k be 0.
  4. Repeat, while k < len,
    1. Let C be the code unit at index k within string.
    2. Let S be C.
    3. If C is the code unit 0x0025 (PERCENT SIGN), then
      1. If k + 3 > len, throw a URIError exception.
      2. Let escape be the substring of string from k to k + 3.
      3. Let B be ParseHexOctet(string, k + 1).
      4. If B is not an integer, throw a URIError exception.
      5. Set k to k + 2.
      6. Let n be the number of leading 1 bits in B.
      7. If n = 0, then
        1. Let asciiChar be the code unit whose numeric value is B.
        2. If preserveEscapeSet contains asciiChar, set S to escape; otherwise set S to asciiChar.
      8. Else,
        1. If n = 1 or n > 4, throw a URIError exception.
        2. Let Octets be « B ».
        3. Let j be 1.
        4. Repeat, while j < n,
          1. Set k to k + 1.
          2. If k + 3 > len, throw a URIError exception.
          3. If the code unit at index k within string is not the code unit 0x0025 (PERCENT SIGN), throw a URIError exception.
          4. Let continuationByte be ParseHexOctet(string, k + 1).
          5. If continuationByte is not an integer, throw a URIError exception.
          6. Append continuationByte to Octets.
          7. Set k to k + 2.
          8. Set j to j + 1.
        5. Assert: The length of Octets is n.
        6. If Octets does not contain a valid UTF-8 encoding of a Unicode code point, throw a URIError exception.
        7. Let V be the code point obtained by applying the UTF-8 transformation to Octets, that is, from a List of octets into a 21-bit value.
        8. Set S to UTF16EncodeCodePoint(V).
    4. Set R to the string-concatenation of R and S.
    5. Set k to k + 1.
  5. Return R.
Note

RFC 3629 prohibits the decoding of invalid UTF-8 octet sequences. For example, the invalid sequence 0xC0 0x80 must not decode into the code unit 0x0000. Implementations of the Decode algorithm are required to throw a URIError when encountering such invalid sequences.

19.2.6.7 ParseHexOctet ( string, position )

The abstract operation ParseHexOctet takes arguments string (a String) and position (a non-negative integer) and returns either a non-negative integer or a non-empty List of SyntaxError objects. It parses a sequence of two hexadecimal characters at the specified position in string into an unsigned 8-bit integer. It performs the following steps when called:

  1. Let len be the length of string.
  2. Assert: position + 2 ≤ len.
  3. Let hexDigits be the substring of string from position to position + 2.
  4. Let parseResult be ParseText(hexDigits, HexDigits[~Sep]).
  5. If parseResult is not a Parse Node, return parseResult.
  6. Let n be the MV of parseResult.
  7. Assert: n is in the inclusive interval from 0 to 255.
  8. Return n.

19.3 Constructor Properties of the Global Object

19.3.1 AggregateError ( . . . )

See 20.5.7.1.

19.3.2 Array ( . . . )

See 23.1.1.

19.3.3 ArrayBuffer ( . . . )

See 25.1.4.

19.3.4 BigInt ( . . . )

See 21.2.1.

19.3.5 BigInt64Array ( . . . )

See 23.2.5.

19.3.6 BigUint64Array ( . . . )

See 23.2.5.

19.3.7 Boolean ( . . . )

See 20.3.1.

19.3.8 DataView ( . . . )

See 25.3.2.

19.3.9 Date ( . . . )

See 21.4.2.

19.3.10 Error ( . . . )

See 20.5.1.

19.3.11 EvalError ( . . . )

See 20.5.5.1.

19.3.12 FinalizationRegistry ( . . . )

See 26.2.1.

19.3.13 Float16Array ( . . . )

See 23.2.5.

19.3.14 Float32Array ( . . . )

See 23.2.5.

19.3.15 Float64Array ( . . . )

See 23.2.5.

19.3.16 Function ( . . . )

See 20.2.1.

19.3.17 Int8Array ( . . . )

See 23.2.5.

19.3.18 Int16Array ( . . . )

See 23.2.5.

19.3.19 Int32Array ( . . . )

See 23.2.5.

19.3.20 Iterator ( . . . )

See 27.1.3.1.

19.3.21 Map ( . . . )

See 24.1.1.

19.3.22 Number ( . . . )

See 21.1.1.

19.3.23 Object ( . . . )

See 20.1.1.

19.3.24 Promise ( . . . )

See 27.2.3.

19.3.25 Proxy ( . . . )

See 28.2.1.

19.3.26 RangeError ( . . . )

See 20.5.5.2.

19.3.27 ReferenceError ( . . . )

See 20.5.5.3.

19.3.28 RegExp ( . . . )

See 22.2.4.

19.3.29 Set ( . . . )

See 24.2.2.

19.3.30 SharedArrayBuffer ( . . . )

See 25.2.3.

19.3.31 String ( . . . )

See 22.1.1.

19.3.32 Symbol ( . . . )

See 20.4.1.

19.3.33 SyntaxError ( . . . )

See 20.5.5.4.

19.3.34 TypeError ( . . . )

See 20.5.5.5.

19.3.35 Uint8Array ( . . . )

See 23.2.5.

19.3.36 Uint8ClampedArray ( . . . )

See 23.2.5.

19.3.37 Uint16Array ( . . . )

See 23.2.5.

19.3.38 Uint32Array ( . . . )

See 23.2.5.

19.3.39 URIError ( . . . )

See 20.5.5.6.

19.3.40 WeakMap ( . . . )

See 24.3.1.

19.3.41 WeakRef ( . . . )

See 26.1.1.

19.3.42 WeakSet ( . . . )

See 24.4.

19.4 Other Properties of the Global Object

19.4.1 Atomics

See 25.4.

19.4.2 JSON

See 25.5.

19.4.3 Math

See 21.3.

19.4.4 Reflect

See 28.1.

20 Fundamental Objects

20.1 Object Objects

20.1.1 The Object Constructor

The Object constructor:

  • is %Object%.
  • is the initial value of the "Object" property of the global object.
  • creates a new ordinary object when called as a constructor.
  • performs a type conversion when called as a function rather than as a constructor.
  • may be used as the value of an extends clause of a class definition.

20.1.1.1 Object ( [ value ] )

This function performs the following steps when called:

  1. If NewTarget is neither undefined nor the active function object, then
    1. Return ? OrdinaryCreateFromConstructor(NewTarget, "%Object.prototype%").
  2. If value is either undefined or null, return OrdinaryObjectCreate(%Object.prototype%).
  3. Return ! ToObject(value).

20.1.2 Properties of the Object Constructor

The Object constructor:

  • has a [[Prototype]] internal slot whose value is %Function.prototype%.
  • has a "length" property whose value is 1𝔽.
  • has the following additional properties:

20.1.2.1 Object.assign ( target, ...sources )

This function copies the values of all of the enumerable own properties from one or more source objects to a target object.

It performs the following steps when called:

  1. Let to be ? ToObject(target).
  2. If only one argument was passed, return to.
  3. For each element nextSource of sources, do
    1. If nextSource is neither undefined nor null, then
      1. Let from be ! ToObject(nextSource).
      2. Let keys be ? from.[[OwnPropertyKeys]]().
      3. For each element nextKey of keys, do
        1. Let desc be ? from.[[GetOwnProperty]](nextKey).
        2. If desc is not undefined and desc.[[Enumerable]] is true, then
          1. Let propValue be ? Get(from, nextKey).
          2. Perform ? Set(to, nextKey, propValue, true).
  4. Return to.

The "length" property of this function is 2𝔽.

20.1.2.2 Object.create ( O, Properties )

This function creates a new object with a specified prototype.

It performs the following steps when called:

  1. If O is not an Object and O is not null, throw a TypeError exception.
  2. Let obj be OrdinaryObjectCreate(O).
  3. If Properties is not undefined, then
    1. Return ? ObjectDefineProperties(obj, Properties).
  4. Return obj.

20.1.2.3 Object.defineProperties ( O, Properties )

This function adds own properties and/or updates the attributes of existing own properties of an object.

It performs the following steps when called:

  1. If O is not an Object, throw a TypeError exception.
  2. Return ? ObjectDefineProperties(O, Properties).

20.1.2.3.1 ObjectDefineProperties ( O, Properties )

The abstract operation ObjectDefineProperties takes arguments O (an Object) and Properties (an ECMAScript language value) and returns either a normal completion containing an Object or a throw completion. It performs the following steps when called:

  1. Let props be ? ToObject(Properties).
  2. Let keys be ? props.[[OwnPropertyKeys]]().
  3. Let descriptors be a new empty List.
  4. For each element nextKey of keys, do
    1. Let propDesc be ? props.[[GetOwnProperty]](nextKey).
    2. If propDesc is not undefined and propDesc.[[Enumerable]] is true, then
      1. Let descObj be ? Get(props, nextKey).
      2. Let desc be ? ToPropertyDescriptor(descObj).
      3. Append the Record { [[Key]]: nextKey, [[Descriptor]]: desc } to descriptors.
  5. For each element property of descriptors, do
    1. Perform ? DefinePropertyOrThrow(O, property.[[Key]], property.[[Descriptor]]).
  6. Return O.

20.1.2.4 Object.defineProperty ( O, P, Attributes )

This function adds an own property and/or updates the attributes of an existing own property of an object.

It performs the following steps when called:

  1. If O is not an Object, throw a TypeError exception.
  2. Let key be ? ToPropertyKey(P).
  3. Let desc be ? ToPropertyDescriptor(Attributes).
  4. Perform ? DefinePropertyOrThrow(O, key, desc).
  5. Return O.

20.1.2.5 Object.entries ( O )

This function performs the following steps when called:

  1. Let obj be ? ToObject(O).
  2. Let entryList be ? EnumerableOwnProperties(obj, key+value).
  3. Return CreateArrayFromList(entryList).

20.1.2.6 Object.freeze ( O )

This function performs the following steps when called:

  1. If O is not an Object, return O.
  2. Let status be ? SetIntegrityLevel(O, frozen).
  3. If status is false, throw a TypeError exception.
  4. Return O.

20.1.2.7 Object.fromEntries ( iterable )

This function performs the following steps when called:

  1. Perform ? RequireObjectCoercible(iterable).
  2. Let obj be OrdinaryObjectCreate(%Object.prototype%).
  3. Assert: obj is an extensible ordinary object with no own properties.
  4. Let closure be a new Abstract Closure with parameters (key, value) that captures obj and performs the following steps when called:
    1. Let propertyKey be ? ToPropertyKey(key).
    2. Perform ! CreateDataPropertyOrThrow(obj, propertyKey, value).
    3. Return NormalCompletion(undefined).
  5. Let adder be CreateBuiltinFunction(closure, 2, "", « »).
  6. Return ? AddEntriesFromIterable(obj, iterable, adder).
Note
The function created for adder is never directly accessible to ECMAScript code.

20.1.2.8 Object.getOwnPropertyDescriptor ( O, P )

This function performs the following steps when called:

  1. Let obj be ? ToObject(O).
  2. Let key be ? ToPropertyKey(P).
  3. Let desc be ? obj.[[GetOwnProperty]](key).
  4. Return FromPropertyDescriptor(desc).

20.1.2.9 Object.getOwnPropertyDescriptors ( O )

This function performs the following steps when called:

  1. Let obj be ? ToObject(O).
  2. Let ownKeys be ? obj.[[OwnPropertyKeys]]().
  3. Let descriptors be OrdinaryObjectCreate(%Object.prototype%).
  4. For each element key of ownKeys, do
    1. Let desc be ? obj.[[GetOwnProperty]](key).
    2. Let descriptor be FromPropertyDescriptor(desc).
    3. If descriptor is not undefined, perform ! CreateDataPropertyOrThrow(descriptors, key, descriptor).
  5. Return descriptors.

20.1.2.10 Object.getOwnPropertyNames ( O )

This function performs the following steps when called:

  1. Return CreateArrayFromList(? GetOwnPropertyKeys(O, string)).

20.1.2.11 Object.getOwnPropertySymbols ( O )

This function performs the following steps when called:

  1. Return CreateArrayFromList(? GetOwnPropertyKeys(O, symbol)).

20.1.2.11.1 GetOwnPropertyKeys ( O, type )

The abstract operation GetOwnPropertyKeys takes arguments O (an ECMAScript language value) and type (string or symbol) and returns either a normal completion containing a List of property keys or a throw completion. It performs the following steps when called:

  1. Let obj be ? ToObject(O).
  2. Let keys be ? obj.[[OwnPropertyKeys]]().
  3. Let nameList be a new empty List.
  4. For each element nextKey of keys, do
    1. If nextKey is a Symbol and type is symbol, or if nextKey is a String and type is string, then
      1. Append nextKey to nameList.
  5. Return nameList.

20.1.2.12 Object.getPrototypeOf ( O )

This function performs the following steps when called:

  1. Let obj be ? ToObject(O).
  2. Return ? obj.[[GetPrototypeOf]]().

20.1.2.13 Object.groupBy ( items, callback )

Note

callback should be a function that accepts two arguments. groupBy calls callback once for each element in items, in ascending order, and constructs a new object. Each value returned by callback is coerced to a property key. For each such property key, the result object has a property whose key is that property key and whose value is an array containing all the elements for which the callback return value coerced to that key.

callback is called with two arguments: the value of the element and the index of the element.

The return value of groupBy is an object that does not inherit from %Object.prototype%.

This function performs the following steps when called:

  1. Let groups be ? GroupBy(items, callback, property).
  2. Let obj be OrdinaryObjectCreate(null).
  3. For each Record { [[Key]], [[Elements]] } g of groups, do
    1. Let elements be CreateArrayFromList(g.[[Elements]]).
    2. Perform ! CreateDataPropertyOrThrow(obj, g.[[Key]], elements).
  4. Return obj.

20.1.2.14 Object.hasOwn ( O, P )

This function performs the following steps when called:

  1. Let obj be ? ToObject(O).
  2. Let key be ? ToPropertyKey(P).
  3. Return ? HasOwnProperty(obj, key).

20.1.2.15 Object.is ( value1, value2 )

This function performs the following steps when called:

  1. Return SameValue(value1, value2).

20.1.2.16 Object.isExtensible ( O )

This function performs the following steps when called:

  1. If O is not an Object, return false.
  2. Return ? IsExtensible(O).

20.1.2.17 Object.isFrozen ( O )

This function performs the following steps when called:

  1. If O is not an Object, return true.
  2. Return ? TestIntegrityLevel(O, frozen).

20.1.2.18 Object.isSealed ( O )

This function performs the following steps when called:

  1. If O is not an Object, return true.
  2. Return ? TestIntegrityLevel(O, sealed).

20.1.2.19 Object.keys ( O )

This function performs the following steps when called:

  1. Let obj be ? ToObject(O).
  2. Let keyList be ? EnumerableOwnProperties(obj, key).
  3. Return CreateArrayFromList(keyList).

20.1.2.20 Object.preventExtensions ( O )

This function performs the following steps when called:

  1. If O is not an Object, return O.
  2. Let status be ? O.[[PreventExtensions]]().
  3. If status is false, throw a TypeError exception.
  4. Return O.

20.1.2.21 Object.prototype

The initial value of Object.prototype is the Object prototype object.

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: false }.

20.1.2.22 Object.seal ( O )

This function performs the following steps when called:

  1. If O is not an Object, return O.
  2. Let status be ? SetIntegrityLevel(O, sealed).
  3. If status is false, throw a TypeError exception.
  4. Return O.

20.1.2.23 Object.setPrototypeOf ( O, proto )

This function performs the following steps when called:

  1. Set O to ? RequireObjectCoercible(O).
  2. If proto is not an Object and proto is not null, throw a TypeError exception.
  3. If O is not an Object, return O.
  4. Let status be ? O.[[SetPrototypeOf]](proto).
  5. If status is false, throw a TypeError exception.
  6. Return O.

20.1.2.24 Object.values ( O )

This function performs the following steps when called:

  1. Let obj be ? ToObject(O).
  2. Let valueList be ? EnumerableOwnProperties(obj, value).
  3. Return CreateArrayFromList(valueList).

20.1.3 Properties of the Object Prototype Object

The Object prototype object:

  • is %Object.prototype%.
  • has an [[Extensible]] internal slot whose value is true.
  • has the internal methods defined for ordinary objects, except for the [[SetPrototypeOf]] method, which is as defined in 10.4.7.1. (Thus, it is an immutable prototype exotic object.)
  • has a [[Prototype]] internal slot whose value is null.

20.1.3.1 Object.prototype.constructor

The initial value of Object.prototype.constructor is %Object%.

20.1.3.2 Object.prototype.hasOwnProperty ( V )

This method performs the following steps when called:

  1. Let P be ? ToPropertyKey(V).
  2. Let O be ? ToObject(this value).
  3. Return ? HasOwnProperty(O, P).
Note

The ordering of steps 1 and 2 is chosen to ensure that any exception that would have been thrown by step 1 in previous editions of this specification will continue to be thrown even if the this value is undefined or null.

20.1.3.3 Object.prototype.isPrototypeOf ( V )

This method performs the following steps when called:

  1. If V is not an Object, return false.
  2. Let O be ? ToObject(this value).
  3. Repeat,
    1. Set V to ? V.[[GetPrototypeOf]]().
    2. If V is null, return false.
    3. If SameValue(O, V) is true, return true.
Note

The ordering of steps 1 and 2 preserves the behaviour specified by previous editions of this specification for the case where V is not an object and the this value is undefined or null.

20.1.3.4 Object.prototype.propertyIsEnumerable ( V )

This method performs the following steps when called:

  1. Let P be ? ToPropertyKey(V).
  2. Let O be ? ToObject(this value).
  3. Let desc be ? O.[[GetOwnProperty]](P).
  4. If desc is undefined, return false.
  5. Return desc.[[Enumerable]].
Note 1

This method does not consider objects in the prototype chain.

Note 2

The ordering of steps 1 and 2 is chosen to ensure that any exception that would have been thrown by step 1 in previous editions of this specification will continue to be thrown even if the this value is undefined or null.

20.1.3.5 Object.prototype.toLocaleString ( [ reserved1 [ , reserved2 ] ] )

This method performs the following steps when called:

  1. Let O be the this value.
  2. Return ? Invoke(O, "toString").

The optional parameters to this method are not used but are intended to correspond to the parameter pattern used by ECMA-402 toLocaleString methods. Implementations that do not include ECMA-402 support must not use those parameter positions for other purposes.

Note 1

This method provides a generic toLocaleString implementation for objects that have no locale-sensitive toString behaviour. Array, Number, Date, and %TypedArray% provide their own locale-sensitive toLocaleString methods.

Note 2

ECMA-402 intentionally does not provide an alternative to this default implementation.

20.1.3.6 Object.prototype.toString ( )

This method performs the following steps when called:

  1. If the this value is undefined, return "[object Undefined]".
  2. If the this value is null, return "[object Null]".
  3. Let O be ! ToObject(this value).
  4. Let isArray be ? IsArray(O).
  5. If isArray is true, let builtinTag be "Array".
  6. Else if O has a [[ParameterMap]] internal slot, let builtinTag be "Arguments".
  7. Else if O has a [[Call]] internal method, let builtinTag be "Function".
  8. Else if O has an [[ErrorData]] internal slot, let builtinTag be "Error".
  9. Else if O has a [[BooleanData]] internal slot, let builtinTag be "Boolean".
  10. Else if O has a [[NumberData]] internal slot, let builtinTag be "Number".
  11. Else if O has a [[StringData]] internal slot, let builtinTag be "String".
  12. Else if O has a [[DateValue]] internal slot, let builtinTag be "Date".
  13. Else if O has a [[RegExpMatcher]] internal slot, let builtinTag be "RegExp".
  14. Else, let builtinTag be "Object".
  15. Let tag be ? Get(O, %Symbol.toStringTag%).
  16. If tag is not a String, set tag to builtinTag.
  17. Return the string-concatenation of "[object ", tag, and "]".
Note

Historically, this method was occasionally used to access the String value of the [[Class]] internal slot that was used in previous editions of this specification as a nominal type tag for various built-in objects. The above definition of toString preserves compatibility for legacy code that uses toString as a test for those specific kinds of built-in objects. It does not provide a reliable type testing mechanism for other kinds of built-in or program defined objects. In addition, programs can use %Symbol.toStringTag% in ways that will invalidate the reliability of such legacy type tests.

20.1.3.7 Object.prototype.valueOf ( )

This method performs the following steps when called:

  1. Return ? ToObject(this value).

20.1.3.8 Object.prototype.__proto__

Object.prototype.__proto__ is an accessor property with attributes { [[Enumerable]]: false, [[Configurable]]: true }. The [[Get]] and [[Set]] attributes are defined as follows:

20.1.3.8.1 get Object.prototype.__proto__

The value of the [[Get]] attribute is a built-in function that requires no arguments. It performs the following steps when called:

  1. Let O be ? ToObject(this value).
  2. Return ? O.[[GetPrototypeOf]]().

20.1.3.8.2 set Object.prototype.__proto__

The value of the [[Set]] attribute is a built-in function that takes an argument proto. It performs the following steps when called:

  1. Let O be ? RequireObjectCoercible(this value).
  2. If proto is not an Object and proto is not null, return undefined.
  3. If O is not an Object, return undefined.
  4. Let status be ? O.[[SetPrototypeOf]](proto).
  5. If status is false, throw a TypeError exception.
  6. Return undefined.

20.1.3.9 Legacy Object.prototype Accessor Methods

20.1.3.9.1 Object.prototype.__defineGetter__ ( P, getter )

This method performs the following steps when called:

  1. Let O be ? ToObject(this value).
  2. If IsCallable(getter) is false, throw a TypeError exception.
  3. Let desc be PropertyDescriptor { [[Get]]: getter, [[Enumerable]]: true, [[Configurable]]: true }.
  4. Let key be ? ToPropertyKey(P).
  5. Perform ? DefinePropertyOrThrow(O, key, desc).
  6. Return undefined.

20.1.3.9.2 Object.prototype.__defineSetter__ ( P, setter )

This method performs the following steps when called:

  1. Let O be ? ToObject(this value).
  2. If IsCallable(setter) is false, throw a TypeError exception.
  3. Let desc be PropertyDescriptor { [[Set]]: setter, [[Enumerable]]: true, [[Configurable]]: true }.
  4. Let key be ? ToPropertyKey(P).
  5. Perform ? DefinePropertyOrThrow(O, key, desc).
  6. Return undefined.

20.1.3.9.3 Object.prototype.__lookupGetter__ ( P )

This method performs the following steps when called:

  1. Let O be ? ToObject(this value).
  2. Let key be ? ToPropertyKey(P).
  3. Repeat,
    1. Let desc be ? O.[[GetOwnProperty]](key).
    2. If desc is not undefined, then
      1. If IsAccessorDescriptor(desc) is true, return desc.[[Get]].
      2. Return undefined.
    3. Set O to ? O.[[GetPrototypeOf]]().
    4. If O is null, return undefined.

20.1.3.9.4 Object.prototype.__lookupSetter__ ( P )

This method performs the following steps when called:

  1. Let O be ? ToObject(this value).
  2. Let key be ? ToPropertyKey(P).
  3. Repeat,
    1. Let desc be ? O.[[GetOwnProperty]](key).
    2. If desc is not undefined, then
      1. If IsAccessorDescriptor(desc) is true, return desc.[[Set]].
      2. Return undefined.
    3. Set O to ? O.[[GetPrototypeOf]]().
    4. If O is null, return undefined.

20.1.4 Properties of Object Instances

Object instances have no special properties beyond those inherited from the Object prototype object.

20.2 Function Objects

20.2.1 The Function Constructor

The Function constructor:

  • is %Function%.
  • is the initial value of the "Function" property of the global object.
  • creates and initializes a new function object when called as a function rather than as a constructor. Thus the function call Function(…) is equivalent to the object creation expression new Function(…) with the same arguments.
  • may be used as the value of an extends clause of a class definition. Subclass constructors that intend to inherit the specified Function behaviour must include a super call to the Function constructor to create and initialize a subclass instance with the internal slots necessary for built-in function behaviour. All ECMAScript syntactic forms for defining function objects create instances of Function. There is no syntactic means to create instances of Function subclasses except for the built-in GeneratorFunction, AsyncFunction, and AsyncGeneratorFunction subclasses.

20.2.1.1 Function ( ...parameterArgs, bodyArg )

The last argument (if any) specifies the body (executable code) of a function; any preceding arguments specify formal parameters.

This function performs the following steps when called:

  1. Let C be the active function object.
  2. If bodyArg is not present, set bodyArg to the empty String.
  3. Return ? CreateDynamicFunction(C, NewTarget, normal, parameterArgs, bodyArg).
Note

It is permissible but not necessary to have one argument for each formal parameter to be specified. For example, all three of the following expressions produce the same result:

new Function("a", "b", "c", "return a+b+c")
new Function("a, b, c", "return a+b+c")
new Function("a,b", "c", "return a+b+c")

20.2.1.1.1 CreateDynamicFunction ( constructor, newTarget, kind, parameterArgs, bodyArg )

The abstract operation CreateDynamicFunction takes arguments constructor (a constructor), newTarget (a constructor or undefined), kind (normal, generator, async, or async-generator), parameterArgs (a List of ECMAScript language values), and bodyArg (an ECMAScript language value) and returns either a normal completion containing an ECMAScript function object or a throw completion. constructor is the constructor function that is performing this action. newTarget is the constructor that new was initially applied to. parameterArgs and bodyArg reflect the argument values that were passed to constructor. It performs the following steps when called:

  1. If newTarget is undefined, set newTarget to constructor.
  2. If kind is normal, then
    1. Let prefix be "function".
    2. Let exprSym be the grammar symbol FunctionExpression.
    3. Let bodySym be the grammar symbol FunctionBody[~Yield, ~Await].
    4. Let parameterSym be the grammar symbol FormalParameters[~Yield, ~Await].
    5. Let fallbackProto be "%Function.prototype%".
  3. Else if kind is generator, then
    1. Let prefix be "function*".
    2. Let exprSym be the grammar symbol GeneratorExpression.
    3. Let bodySym be the grammar symbol GeneratorBody.
    4. Let parameterSym be the grammar symbol FormalParameters[+Yield, ~Await].
    5. Let fallbackProto be "%GeneratorFunction.prototype%".
  4. Else if kind is async, then
    1. Let prefix be "async function".
    2. Let exprSym be the grammar symbol AsyncFunctionExpression.
    3. Let bodySym be the grammar symbol AsyncFunctionBody.
    4. Let parameterSym be the grammar symbol FormalParameters[~Yield, +Await].
    5. Let fallbackProto be "%AsyncFunction.prototype%".
  5. Else,
    1. Assert: kind is async-generator.
    2. Let prefix be "async function*".
    3. Let exprSym be the grammar symbol AsyncGeneratorExpression.
    4. Let bodySym be the grammar symbol AsyncGeneratorBody.
    5. Let parameterSym be the grammar symbol FormalParameters[+Yield, +Await].
    6. Let fallbackProto be "%AsyncGeneratorFunction.prototype%".
  6. Let argCount be the number of elements in parameterArgs.
  7. Let parameterStrings be a new empty List.
  8. For each element arg of parameterArgs, do
    1. Append ? ToString(arg) to parameterStrings.
  9. Let bodyString be ? ToString(bodyArg).
  10. Let currentRealm be the current Realm Record.
  11. Perform ? HostEnsureCanCompileStrings(currentRealm, parameterStrings, bodyString, false).
  12. Let P be the empty String.
  13. If argCount > 0, then
    1. Set P to parameterStrings[0].
    2. Let k be 1.
    3. Repeat, while k < argCount,
      1. Let nextArgString be parameterStrings[k].
      2. Set P to the string-concatenation of P, "," (a comma), and nextArgString.
      3. Set k to k + 1.
  14. Let bodyParseString be the string-concatenation of 0x000A (LINE FEED), bodyString, and 0x000A (LINE FEED).
  15. Let sourceString be the string-concatenation of prefix, " anonymous(", P, 0x000A (LINE FEED), ") {", bodyParseString, and "}".
  16. Let sourceText be StringToCodePoints(sourceString).
  17. Let parameters be ParseText(P, parameterSym).
  18. If parameters is a List of errors, throw a SyntaxError exception.
  19. Let body be ParseText(bodyParseString, bodySym).
  20. If body is a List of errors, throw a SyntaxError exception.
  21. NOTE: The parameters and body are parsed separately to ensure that each is valid alone. For example, new Function("/*", "*/ ) {") does not evaluate to a function.
  22. NOTE: If this step is reached, sourceText must have the syntax of exprSym (although the reverse implication does not hold). The purpose of the next two steps is to enforce any Early Error rules which apply to exprSym directly.
  23. Let expr be ParseText(sourceText, exprSym).
  24. If expr is a List of errors, throw a SyntaxError exception.
  25. Let proto be ? GetPrototypeFromConstructor(newTarget, fallbackProto).
  26. Let env be currentRealm.[[GlobalEnv]].
  27. Let privateEnv be null.
  28. Let F be OrdinaryFunctionCreate(proto, sourceText, parameters, body, non-lexical-this, env, privateEnv).
  29. Perform SetFunctionName(F, "anonymous").
  30. If kind is generator, then
    1. Let prototype be OrdinaryObjectCreate(%GeneratorPrototype%).
    2. Perform ! DefinePropertyOrThrow(F, "prototype", PropertyDescriptor { [[Value]]: prototype, [[Writable]]: true, [[Enumerable]]: false, [[Configurable]]: false }).
  31. Else if kind is async-generator, then
    1. Let prototype be OrdinaryObjectCreate(%AsyncGeneratorPrototype%).
    2. Perform ! DefinePropertyOrThrow(F, "prototype", PropertyDescriptor { [[Value]]: prototype, [[Writable]]: true, [[Enumerable]]: false, [[Configurable]]: false }).
  32. Else if kind is normal, then
    1. Perform MakeConstructor(F).
  33. NOTE: Functions whose kind is async are not constructable and do not have a [[Construct]] internal method or a "prototype" property.
  34. Return F.
Note

CreateDynamicFunction defines a "prototype" property on any function it creates whose kind is not async to provide for the possibility that the function will be used as a constructor.

20.2.2 Properties of the Function Constructor

The Function constructor:

  • is itself a built-in function object.
  • has a [[Prototype]] internal slot whose value is %Function.prototype%.
  • has a "length" property whose value is 1𝔽.
  • has the following properties:

20.2.2.1 Function.prototype

The value of Function.prototype is the Function prototype object.

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: false }.

20.2.3 Properties of the Function Prototype Object

The Function prototype object:

  • is %Function.prototype%.
  • is itself a built-in function object.
  • accepts any arguments and returns undefined when invoked.
  • does not have a [[Construct]] internal method; it cannot be used as a constructor with the new operator.
  • has a [[Prototype]] internal slot whose value is %Object.prototype%.
  • does not have a "prototype" property.
  • has a "length" property whose value is +0𝔽.
  • has a "name" property whose value is the empty String.
Note

The Function prototype object is specified to be a function object to ensure compatibility with ECMAScript code that was created prior to the ECMAScript 2015 specification.

20.2.3.1 Function.prototype.apply ( thisArg, argArray )

This method performs the following steps when called:

  1. Let func be the this value.
  2. If IsCallable(func) is false, throw a TypeError exception.
  3. If argArray is either undefined or null, then
    1. Perform PrepareForTailCall().
    2. Return ? Call(func, thisArg).
  4. Let argList be ? CreateListFromArrayLike(argArray).
  5. Perform PrepareForTailCall().
  6. Return ? Call(func, thisArg, argList).
Note 1

The thisArg value is passed without modification as the this value. This is a change from Edition 3, where an undefined or null thisArg is replaced with the global object and ToObject is applied to all other values and that result is passed as the this value. Even though the thisArg is passed without modification, non-strict functions still perform these transformations upon entry to the function.

Note 2

If func is either an arrow function or a bound function exotic object, then the thisArg will be ignored by the function [[Call]] in step 6.

20.2.3.2 Function.prototype.bind ( thisArg, ...args )

This method performs the following steps when called:

  1. Let Target be the this value.
  2. If IsCallable(Target) is false, throw a TypeError exception.
  3. Let F be ? BoundFunctionCreate(Target, thisArg, args).
  4. Let L be 0.
  5. Let targetHasLength be ? HasOwnProperty(Target, "length").
  6. If targetHasLength is true, then
    1. Let targetLen be ? Get(Target, "length").
    2. If targetLen is a Number, then
      1. If targetLen is +∞𝔽, then
        1. Set L to +∞.
      2. Else if targetLen is -∞𝔽, then
        1. Set L to 0.
      3. Else,
        1. Let targetLenAsInt be ! ToIntegerOrInfinity(targetLen).
        2. Assert: targetLenAsInt is finite.
        3. Let argCount be the number of elements in args.
        4. Set L to max(targetLenAsInt - argCount, 0).
  7. Perform SetFunctionLength(F, L).
  8. Let targetName be ? Get(Target, "name").
  9. If targetName is not a String, set targetName to the empty String.
  10. Perform SetFunctionName(F, targetName, "bound").
  11. Return F.
Note 1

Function objects created using Function.prototype.bind are exotic objects. They also do not have a "prototype" property.

Note 2

If Target is either an arrow function or a bound function exotic object, then the thisArg passed to this method will not be used by subsequent calls to F.

20.2.3.3 Function.prototype.call ( thisArg, ...args )

This method performs the following steps when called:

  1. Let func be the this value.
  2. If IsCallable(func) is false, throw a TypeError exception.
  3. Perform PrepareForTailCall().
  4. Return ? Call(func, thisArg, args).
Note 1

The thisArg value is passed without modification as the this value. This is a change from Edition 3, where an undefined or null thisArg is replaced with the global object and ToObject is applied to all other values and that result is passed as the this value. Even though the thisArg is passed without modification, non-strict functions still perform these transformations upon entry to the function.

Note 2

If func is either an arrow function or a bound function exotic object, then the thisArg will be ignored by the function [[Call]] in step 4.

20.2.3.4 Function.prototype.constructor

The initial value of Function.prototype.constructor is %Function%.

20.2.3.5 Function.prototype.toString ( )

This method performs the following steps when called:

  1. Let func be the this value.
  2. If func is an Object, func has a [[SourceText]] internal slot, func.[[SourceText]] is a sequence of Unicode code points, and HostHasSourceTextAvailable(func) is true, then
    1. Return CodePointsToString(func.[[SourceText]]).
  3. If func is a built-in function object, return an implementation-defined String source code representation of func. The representation must have the syntax of a NativeFunction. Additionally, if func has an [[InitialName]] internal slot and func.[[InitialName]] is a String, the portion of the returned String that would be matched by NativeFunctionAccessoropt PropertyName must be func.[[InitialName]].
  4. If func is an Object and IsCallable(func) is true, return an implementation-defined String source code representation of func. The representation must have the syntax of a NativeFunction.
  5. Throw a TypeError exception.
NativeFunction : function NativeFunctionAccessoropt PropertyName[~Yield, ~Await]opt ( FormalParameters[~Yield, ~Await] ) { [ native code ] } NativeFunctionAccessor : get set

20.2.3.6 Function.prototype [ %Symbol.hasInstance% ] ( V )

This method performs the following steps when called:

  1. Let F be the this value.
  2. Return ? OrdinaryHasInstance(F, V).

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: false }.

Note

This is the default implementation of %Symbol.hasInstance% that most functions inherit. %Symbol.hasInstance% is called by the instanceof operator to determine whether a value is an instance of a specific constructor. An expression such as

v instanceof F

evaluates as

F[%Symbol.hasInstance%](v)

A constructor function can control which objects are recognized as its instances by instanceof by exposing a different %Symbol.hasInstance% method on the function.

This property is non-writable and non-configurable to prevent tampering that could be used to globally expose the target function of a bound function.

The value of the "name" property of this method is "[Symbol.hasInstance]".

20.2.4 Function Instances

Every Function instance is an ECMAScript function object and has the internal slots listed in Table 30. Function objects created using the Function.prototype.bind method (20.2.3.2) have the internal slots listed in Table 31.

Function instances have the following properties:

20.2.4.1 length

The value of the "length" property is an integral Number that indicates the typical number of arguments expected by the function. However, the language permits the function to be invoked with some other number of arguments. The behaviour of a function when invoked on a number of arguments other than the number specified by its "length" property depends on the function. This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: true }.

20.2.4.2 name

The value of the "name" property is a String that is descriptive of the function. The name has no semantic significance but is typically a variable or property name that is used to refer to the function at its point of definition in ECMAScript source text. This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: true }.

Anonymous functions objects that do not have a contextual name associated with them by this specification use the empty String as the value of the "name" property.

20.2.4.3 prototype

Function instances that can be used as a constructor have a "prototype" property. Whenever such a Function instance is created another ordinary object is also created and is the initial value of the function's "prototype" property. Unless otherwise specified, the value of the "prototype" property is used to initialize the [[Prototype]] internal slot of the object created when that function is invoked as a constructor.

This property has the attributes { [[Writable]]: true, [[Enumerable]]: false, [[Configurable]]: false }.

Note

Function objects created using Function.prototype.bind, or by evaluating a MethodDefinition (that is not a GeneratorMethod or AsyncGeneratorMethod) or an ArrowFunction do not have a "prototype" property.

20.2.5 HostHasSourceTextAvailable ( func )

The host-defined abstract operation HostHasSourceTextAvailable takes argument func (a function object) and returns a Boolean. It allows host environments to prevent the source text from being provided for func.

An implementation of HostHasSourceTextAvailable must conform to the following requirements:

  • It must be deterministic with respect to its parameters. Each time it is called with a specific func as its argument, it must return the same result.

The default implementation of HostHasSourceTextAvailable is to return true.

20.3 Boolean Objects

20.3.1 The Boolean Constructor

The Boolean constructor:

  • is %Boolean%.
  • is the initial value of the "Boolean" property of the global object.
  • creates and initializes a new Boolean object when called as a constructor.
  • performs a type conversion when called as a function rather than as a constructor.
  • may be used as the value of an extends clause of a class definition. Subclass constructors that intend to inherit the specified Boolean behaviour must include a super call to the Boolean constructor to create and initialize the subclass instance with a [[BooleanData]] internal slot.

20.3.1.1 Boolean ( value )

This function performs the following steps when called:

  1. Let b be ToBoolean(value).
  2. If NewTarget is undefined, return b.
  3. Let O be ? OrdinaryCreateFromConstructor(NewTarget, "%Boolean.prototype%", « [[BooleanData]] »).
  4. Set O.[[BooleanData]] to b.
  5. Return O.

20.3.2 Properties of the Boolean Constructor

The Boolean constructor:

  • has a [[Prototype]] internal slot whose value is %Function.prototype%.
  • has the following properties:

20.3.2.1 Boolean.prototype

The initial value of Boolean.prototype is the Boolean prototype object.

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: false }.

20.3.3 Properties of the Boolean Prototype Object

The Boolean prototype object:

  • is %Boolean.prototype%.
  • is an ordinary object.
  • is itself a Boolean object; it has a [[BooleanData]] internal slot with the value false.
  • has a [[Prototype]] internal slot whose value is %Object.prototype%.

20.3.3.1 Boolean.prototype.constructor

The initial value of Boolean.prototype.constructor is %Boolean%.

20.3.3.2 Boolean.prototype.toString ( )

This method performs the following steps when called:

  1. Let b be ? ThisBooleanValue(this value).
  2. If b is true, return "true"; else return "false".

20.3.3.3 Boolean.prototype.valueOf ( )

This method performs the following steps when called:

  1. Return ? ThisBooleanValue(this value).

20.3.3.3.1 ThisBooleanValue ( value )

The abstract operation ThisBooleanValue takes argument value (an ECMAScript language value) and returns either a normal completion containing a Boolean or a throw completion. It performs the following steps when called:

  1. If value is a Boolean, return value.
  2. If value is an Object and value has a [[BooleanData]] internal slot, then
    1. Let b be value.[[BooleanData]].
    2. Assert: b is a Boolean.
    3. Return b.
  3. Throw a TypeError exception.

20.3.4 Properties of Boolean Instances

Boolean instances are ordinary objects that inherit properties from the Boolean prototype object. Boolean instances have a [[BooleanData]] internal slot. The [[BooleanData]] internal slot is the Boolean value represented by this Boolean object.

20.4 Symbol Objects

20.4.1 The Symbol Constructor

The Symbol constructor:

  • is %Symbol%.
  • is the initial value of the "Symbol" property of the global object.
  • returns a new Symbol value when called as a function.
  • is not intended to be used with the new operator.
  • is not intended to be subclassed.
  • may be used as the value of an extends clause of a class definition but a super call to it will cause an exception.

20.4.1.1 Symbol ( [ description ] )

This function performs the following steps when called:

  1. If NewTarget is not undefined, throw a TypeError exception.
  2. If description is undefined, let descString be undefined.
  3. Else, let descString be ? ToString(description).
  4. Return a new Symbol whose [[Description]] is descString.

20.4.2 Properties of the Symbol Constructor

The Symbol constructor:

  • has a [[Prototype]] internal slot whose value is %Function.prototype%.
  • has the following properties:

20.4.2.1 Symbol.asyncIterator

The initial value of Symbol.asyncIterator is the well-known symbol %Symbol.asyncIterator% (Table 1).

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: false }.

20.4.2.2 Symbol.for ( key )

This function performs the following steps when called:

  1. Let stringKey be ? ToString(key).
  2. For each element e of the GlobalSymbolRegistry List, do
    1. If e.[[Key]] is stringKey, return e.[[Symbol]].
  3. Assert: The GlobalSymbolRegistry List does not currently contain an entry for stringKey.
  4. Let newSymbol be a new Symbol whose [[Description]] is stringKey.
  5. Append the GlobalSymbolRegistry Record { [[Key]]: stringKey, [[Symbol]]: newSymbol } to the GlobalSymbolRegistry List.
  6. Return newSymbol.

The GlobalSymbolRegistry List is an append-only List that is globally available. It is shared by all realms. Prior to the evaluation of any ECMAScript code, it is initialized as a new empty List. Elements of the GlobalSymbolRegistry List are Records with the structure defined in Table 63.

Table 63: GlobalSymbolRegistry Record Fields
Field Name Value Usage
[[Key]] a String A string key used to globally identify a Symbol.
[[Symbol]] a Symbol A symbol that can be retrieved from any realm.

20.4.2.3 Symbol.hasInstance

The initial value of Symbol.hasInstance is the well-known symbol %Symbol.hasInstance% (Table 1).

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: false }.

20.4.2.4 Symbol.isConcatSpreadable

The initial value of Symbol.isConcatSpreadable is the well-known symbol %Symbol.isConcatSpreadable% (Table 1).

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: false }.

20.4.2.5 Symbol.iterator

The initial value of Symbol.iterator is the well-known symbol %Symbol.iterator% (Table 1).

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: false }.

20.4.2.6 Symbol.keyFor ( sym )

This function performs the following steps when called:

  1. If sym is not a Symbol, throw a TypeError exception.
  2. Return KeyForSymbol(sym).

20.4.2.7 Symbol.match

The initial value of Symbol.match is the well-known symbol %Symbol.match% (Table 1).

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: false }.

20.4.2.8 Symbol.matchAll

The initial value of Symbol.matchAll is the well-known symbol %Symbol.matchAll% (Table 1).

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: false }.

20.4.2.9 Symbol.prototype

The initial value of Symbol.prototype is the Symbol prototype object.

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: false }.

20.4.2.10 Symbol.replace

The initial value of Symbol.replace is the well-known symbol %Symbol.replace% (Table 1).

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: false }.

20.4.2.11 Symbol.search

The initial value of Symbol.search is the well-known symbol %Symbol.search% (Table 1).

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: false }.

20.4.2.12 Symbol.species

The initial value of Symbol.species is the well-known symbol %Symbol.species% (Table 1).

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: false }.

20.4.2.13 Symbol.split

The initial value of Symbol.split is the well-known symbol %Symbol.split% (Table 1).

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: false }.

20.4.2.14 Symbol.toPrimitive

The initial value of Symbol.toPrimitive is the well-known symbol %Symbol.toPrimitive% (Table 1).

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: false }.

20.4.2.15 Symbol.toStringTag

The initial value of Symbol.toStringTag is the well-known symbol %Symbol.toStringTag% (Table 1).

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: false }.

20.4.2.16 Symbol.unscopables

The initial value of Symbol.unscopables is the well-known symbol %Symbol.unscopables% (Table 1).

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: false }.

20.4.3 Properties of the Symbol Prototype Object

The Symbol prototype object:

20.4.3.1 Symbol.prototype.constructor

The initial value of Symbol.prototype.constructor is %Symbol%.

20.4.3.2 get Symbol.prototype.description

Symbol.prototype.description is an accessor property whose set accessor function is undefined. Its get accessor function performs the following steps when called:

  1. Let s be the this value.
  2. Let sym be ? ThisSymbolValue(s).
  3. Return sym.[[Description]].

20.4.3.3 Symbol.prototype.toString ( )

This method performs the following steps when called:

  1. Let sym be ? ThisSymbolValue(this value).
  2. Return SymbolDescriptiveString(sym).

20.4.3.3.1 SymbolDescriptiveString ( sym )

The abstract operation SymbolDescriptiveString takes argument sym (a Symbol) and returns a String. It performs the following steps when called:

  1. Let desc be sym's [[Description]] value.
  2. If desc is undefined, set desc to the empty String.
  3. Assert: desc is a String.
  4. Return the string-concatenation of "Symbol(", desc, and ")".

20.4.3.4 Symbol.prototype.valueOf ( )

This method performs the following steps when called:

  1. Return ? ThisSymbolValue(this value).

20.4.3.4.1 ThisSymbolValue ( value )

The abstract operation ThisSymbolValue takes argument value (an ECMAScript language value) and returns either a normal completion containing a Symbol or a throw completion. It performs the following steps when called:

  1. If value is a Symbol, return value.
  2. If value is an Object and value has a [[SymbolData]] internal slot, then
    1. Let s be value.[[SymbolData]].
    2. Assert: s is a Symbol.
    3. Return s.
  3. Throw a TypeError exception.

20.4.3.5 Symbol.prototype [ %Symbol.toPrimitive% ] ( hint )

This method is called by ECMAScript language operators to convert a Symbol object to a primitive value.

It performs the following steps when called:

  1. Return ? ThisSymbolValue(this value).
Note

The argument is ignored.

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: true }.

The value of the "name" property of this method is "[Symbol.toPrimitive]".

20.4.3.6 Symbol.prototype [ %Symbol.toStringTag% ]

The initial value of the %Symbol.toStringTag% property is the String value "Symbol".

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: true }.

20.4.4 Properties of Symbol Instances

Symbol instances are ordinary objects that inherit properties from the Symbol prototype object. Symbol instances have a [[SymbolData]] internal slot. The [[SymbolData]] internal slot is the Symbol value represented by this Symbol object.

20.4.5 Abstract Operations for Symbols

20.4.5.1 KeyForSymbol ( sym )

The abstract operation KeyForSymbol takes argument sym (a Symbol) and returns a String or undefined. If sym is in the GlobalSymbolRegistry List, the String used to register sym will be returned. It performs the following steps when called:

  1. For each element e of the GlobalSymbolRegistry List, do
    1. If SameValue(e.[[Symbol]], sym) is true, return e.[[Key]].
  2. Assert: The GlobalSymbolRegistry List does not currently contain an entry for sym.
  3. Return undefined.

20.5 Error Objects

Instances of Error objects are thrown as exceptions when runtime errors occur. The Error objects may also serve as base objects for user-defined exception classes.

When an ECMAScript implementation detects a runtime error, it throws a new instance of one of the NativeError objects defined in 20.5.5 or a new instance of the AggregateError object defined in 20.5.7.

20.5.1 The Error Constructor

The Error constructor:

  • is %Error%.
  • is the initial value of the "Error" property of the global object.
  • creates and initializes a new Error object when called as a function rather than as a constructor. Thus the function call Error(…) is equivalent to the object creation expression new Error(…) with the same arguments.
  • may be used as the value of an extends clause of a class definition. Subclass constructors that intend to inherit the specified Error behaviour must include a super call to the Error constructor to create and initialize subclass instances with an [[ErrorData]] internal slot.

20.5.1.1 Error ( message [ , options ] )

This function performs the following steps when called:

  1. If NewTarget is undefined, let newTarget be the active function object; else let newTarget be NewTarget.
  2. Let O be ? OrdinaryCreateFromConstructor(newTarget, "%Error.prototype%", « [[ErrorData]] »).
  3. If message is not undefined, then
    1. Let msg be ? ToString(message).
    2. Perform CreateNonEnumerableDataPropertyOrThrow(O, "message", msg).
  4. Perform ? InstallErrorCause(O, options).
  5. Return O.

20.5.2 Properties of the Error Constructor

The Error constructor:

  • has a [[Prototype]] internal slot whose value is %Function.prototype%.
  • has the following properties:

20.5.2.1 Error.isError ( arg )

This function performs the following steps when called:

  1. If arg is not an Object, return false.
  2. If arg does not have an [[ErrorData]] internal slot, return false.
  3. Return true.

20.5.2.2 Error.prototype

The initial value of Error.prototype is the Error prototype object.

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: false }.

20.5.3 Properties of the Error Prototype Object

The Error prototype object:

  • is %Error.prototype%.
  • is an ordinary object.
  • is not an Error instance and does not have an [[ErrorData]] internal slot.
  • has a [[Prototype]] internal slot whose value is %Object.prototype%.

20.5.3.1 Error.prototype.constructor

The initial value of Error.prototype.constructor is %Error%.

20.5.3.2 Error.prototype.message

The initial value of Error.prototype.message is the empty String.

20.5.3.3 Error.prototype.name

The initial value of Error.prototype.name is "Error".

20.5.3.4 Error.prototype.toString ( )

This method performs the following steps when called:

  1. Let O be the this value.
  2. If O is not an Object, throw a TypeError exception.
  3. Let name be ? Get(O, "name").
  4. If name is undefined, set name to "Error"; otherwise set name to ? ToString(name).
  5. Let msg be ? Get(O, "message").
  6. If msg is undefined, set msg to the empty String; otherwise set msg to ? ToString(msg).
  7. If name is the empty String, return msg.
  8. If msg is the empty String, return name.
  9. Return the string-concatenation of name, the code unit 0x003A (COLON), the code unit 0x0020 (SPACE), and msg.

20.5.4 Properties of Error Instances

Error instances are ordinary objects that inherit properties from the Error prototype object and have an [[ErrorData]] internal slot whose value is undefined. The only specified use of [[ErrorData]] is to identify Error, AggregateError, and NativeError instances as Error objects within Object.prototype.toString and Error.isError.

20.5.5 Native Error Types Used in This Standard

A new instance of one of the NativeError objects below or of the AggregateError object is thrown when a runtime error is detected. All NativeError objects share the same structure, as described in 20.5.6.

20.5.5.1 EvalError

The EvalError constructor is %EvalError%.

This exception is not currently used within this specification. This object remains for compatibility with previous editions of this specification.

20.5.5.2 RangeError

The RangeError constructor is %RangeError%.

Indicates a value that is not in the set or range of allowable values.

20.5.5.3 ReferenceError

The ReferenceError constructor is %ReferenceError%.

Indicate that an invalid reference has been detected.

20.5.5.4 SyntaxError

The SyntaxError constructor is %SyntaxError%.

Indicates that a parsing error has occurred.

20.5.5.5 TypeError

The TypeError constructor is %TypeError%.

TypeError is used to indicate an unsuccessful operation when none of the other NativeError objects are an appropriate indication of the failure cause.

20.5.5.6 URIError

The URIError constructor is %URIError%.

Indicates that one of the global URI handling functions was used in a way that is incompatible with its definition.

20.5.6 NativeError Object Structure

Each of these objects has the structure described below, differing only in the name used as the constructor name and in the "name" property of the prototype object.

For each error object, references to NativeError in the definition should be replaced with the appropriate error object name from 20.5.5.

20.5.6.1 The NativeError Constructors

Each NativeError constructor:

  • creates and initializes a new NativeError object when called as a function rather than as a constructor. A call of the object as a function is equivalent to calling it as a constructor with the same arguments. Thus the function call NativeError(…) is equivalent to the object creation expression new NativeError(…) with the same arguments.
  • may be used as the value of an extends clause of a class definition. Subclass constructors that intend to inherit the specified NativeError behaviour must include a super call to the NativeError constructor to create and initialize subclass instances with an [[ErrorData]] internal slot.

20.5.6.1.1 NativeError ( message [ , options ] )

Each NativeError function performs the following steps when called:

  1. If NewTarget is undefined, let newTarget be the active function object; else let newTarget be NewTarget.
  2. Let O be ? OrdinaryCreateFromConstructor(newTarget, "%NativeError.prototype%", « [[ErrorData]] »).
  3. If message is not undefined, then
    1. Let msg be ? ToString(message).
    2. Perform CreateNonEnumerableDataPropertyOrThrow(O, "message", msg).
  4. Perform ? InstallErrorCause(O, options).
  5. Return O.

The actual value of the string passed in step 2 is either "%EvalError.prototype%", "%RangeError.prototype%", "%ReferenceError.prototype%", "%SyntaxError.prototype%", "%TypeError.prototype%", or "%URIError.prototype%" corresponding to which NativeError constructor is being defined.

20.5.6.2 Properties of the NativeError Constructors

Each NativeError constructor:

  • has a [[Prototype]] internal slot whose value is %Error%.
  • has a "name" property whose value is the String value "NativeError".
  • has the following properties:

20.5.6.2.1 NativeError.prototype

The initial value of NativeError.prototype is a NativeError prototype object (20.5.6.3). Each NativeError constructor has a distinct prototype object.

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: false }.

20.5.6.3 Properties of the NativeError Prototype Objects

Each NativeError prototype object:

  • is an ordinary object.
  • is not an Error instance and does not have an [[ErrorData]] internal slot.
  • has a [[Prototype]] internal slot whose value is %Error.prototype%.

20.5.6.3.1 NativeError.prototype.constructor

The initial value of the "constructor" property of the prototype for a given NativeError constructor is the constructor itself.

20.5.6.3.2 NativeError.prototype.message

The initial value of the "message" property of the prototype for a given NativeError constructor is the empty String.

20.5.6.3.3 NativeError.prototype.name

The initial value of the "name" property of the prototype for a given NativeError constructor is the String value consisting of the name of the constructor (the name used instead of NativeError).

20.5.6.4 Properties of NativeError Instances

NativeError instances are ordinary objects that inherit properties from their NativeError prototype object and have an [[ErrorData]] internal slot whose value is undefined. The only specified use of [[ErrorData]] is by Object.prototype.toString (20.1.3.6) and Error.isError (20.5.2.1) to identify Error, AggregateError, or NativeError instances.

20.5.7 AggregateError Objects

20.5.7.1 The AggregateError Constructor

The AggregateError constructor:

  • is %AggregateError%.
  • is the initial value of the "AggregateError" property of the global object.
  • creates and initializes a new AggregateError object when called as a function rather than as a constructor. Thus the function call AggregateError(…) is equivalent to the object creation expression new AggregateError(…) with the same arguments.
  • may be used as the value of an extends clause of a class definition. Subclass constructors that intend to inherit the specified AggregateError behaviour must include a super call to the AggregateError constructor to create and initialize subclass instances with an [[ErrorData]] internal slot.

20.5.7.1.1 AggregateError ( errors, message [ , options ] )

This function performs the following steps when called:

  1. If NewTarget is undefined, let newTarget be the active function object; else let newTarget be NewTarget.
  2. Let O be ? OrdinaryCreateFromConstructor(newTarget, "%AggregateError.prototype%", « [[ErrorData]] »).
  3. If message is not undefined, then
    1. Let msg be ? ToString(message).
    2. Perform CreateNonEnumerableDataPropertyOrThrow(O, "message", msg).
  4. Perform ? InstallErrorCause(O, options).
  5. Let errorsList be ? IteratorToList(? GetIterator(errors, sync)).
  6. Perform ! DefinePropertyOrThrow(O, "errors", PropertyDescriptor { [[Configurable]]: true, [[Enumerable]]: false, [[Writable]]: true, [[Value]]: CreateArrayFromList(errorsList) }).
  7. Return O.

20.5.7.2 Properties of the AggregateError Constructor

The AggregateError constructor:

  • has a [[Prototype]] internal slot whose value is %Error%.
  • has the following properties:

20.5.7.2.1 AggregateError.prototype

The initial value of AggregateError.prototype is %AggregateError.prototype%.

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: false }.

20.5.7.3 Properties of the AggregateError Prototype Object

The AggregateError prototype object:

  • is %AggregateError.prototype%.
  • is an ordinary object.
  • is not an Error instance or an AggregateError instance and does not have an [[ErrorData]] internal slot.
  • has a [[Prototype]] internal slot whose value is %Error.prototype%.

20.5.7.3.1 AggregateError.prototype.constructor

The initial value of AggregateError.prototype.constructor is %AggregateError%.

20.5.7.3.2 AggregateError.prototype.message

The initial value of AggregateError.prototype.message is the empty String.

20.5.7.3.3 AggregateError.prototype.name

The initial value of AggregateError.prototype.name is "AggregateError".

20.5.7.4 Properties of AggregateError Instances

AggregateError instances are ordinary objects that inherit properties from their AggregateError prototype object and have an [[ErrorData]] internal slot whose value is undefined. The only specified use of [[ErrorData]] is by Object.prototype.toString (20.1.3.6) and Error.isError (20.5.2.1) to identify Error, AggregateError, or NativeError instances.

20.5.8 Abstract Operations for Error Objects

20.5.8.1 InstallErrorCause ( O, options )

The abstract operation InstallErrorCause takes arguments O (an Object) and options (an ECMAScript language value) and returns either a normal completion containing unused or a throw completion. It is used to create a "cause" property on O when a "cause" property is present on options. It performs the following steps when called:

  1. If options is an Object and ? HasProperty(options, "cause") is true, then
    1. Let cause be ? Get(options, "cause").
    2. Perform CreateNonEnumerableDataPropertyOrThrow(O, "cause", cause).
  2. Return unused.

21 Numbers and Dates

21.1 Number Objects

21.1.1 The Number Constructor

The Number constructor:

  • is %Number%.
  • is the initial value of the "Number" property of the global object.
  • creates and initializes a new Number object when called as a constructor.
  • performs a type conversion when called as a function rather than as a constructor.
  • may be used as the value of an extends clause of a class definition. Subclass constructors that intend to inherit the specified Number behaviour must include a super call to the Number constructor to create and initialize the subclass instance with a [[NumberData]] internal slot.

21.1.1.1 Number ( value )

This function performs the following steps when called:

  1. If value is present, then
    1. Let prim be ? ToNumeric(value).
    2. If prim is a BigInt, let n be 𝔽((prim)).
    3. Otherwise, let n be prim.
  2. Else,
    1. Let n be +0𝔽.
  3. If NewTarget is undefined, return n.
  4. Let O be ? OrdinaryCreateFromConstructor(NewTarget, "%Number.prototype%", « [[NumberData]] »).
  5. Set O.[[NumberData]] to n.
  6. Return O.

21.1.2 Properties of the Number Constructor

The Number constructor:

  • has a [[Prototype]] internal slot whose value is %Function.prototype%.
  • has the following properties:

21.1.2.1 Number.EPSILON

The value of Number.EPSILON is the Number value for the magnitude of the difference between 1 and the smallest value greater than 1 that is representable as a Number value, which is approximately 2.2204460492503130808472633361816 × 10-16.

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: false }.

21.1.2.2 Number.isFinite ( number )

This function performs the following steps when called:

  1. If number is not a Number, return false.
  2. If number is not finite, return false.
  3. Otherwise, return true.

21.1.2.3 Number.isInteger ( number )

This function performs the following steps when called:

  1. If number is an integral Number, return true.
  2. Return false.

21.1.2.4 Number.isNaN ( number )

This function performs the following steps when called:

  1. If number is not a Number, return false.
  2. If number is NaN, return true.
  3. Otherwise, return false.
Note

This function differs from the global isNaN function (19.2.3) in that it does not convert its argument to a Number before determining whether it is NaN.

21.1.2.5 Number.isSafeInteger ( number )

Note

An integer n is a "safe integer" if and only if the Number value for n is not the Number value for any other integer.

This function performs the following steps when called:

  1. If number is an integral Number, then
    1. If abs((number)) ≤ 253 - 1, return true.
  2. Return false.

21.1.2.6 Number.MAX_SAFE_INTEGER

Note

Due to rounding behaviour necessitated by precision limitations of IEEE 754-2019, the Number value for every integer greater than Number.MAX_SAFE_INTEGER is shared with at least one other integer. Such large-magnitude integers are therefore not safe, and are not guaranteed to be exactly representable as Number values or even to be distinguishable from each other. For example, both 9007199254740992 and 9007199254740993 evaluate to the Number value 9007199254740992𝔽.

The value of Number.MAX_SAFE_INTEGER is 9007199254740991𝔽 (𝔽(253 - 1)).

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: false }.

21.1.2.7 Number.MAX_VALUE

The value of Number.MAX_VALUE is the largest positive finite value of the Number type, which is approximately 1.7976931348623157 × 10308.

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: false }.

21.1.2.8 Number.MIN_SAFE_INTEGER

Note

Due to rounding behaviour necessitated by precision limitations of IEEE 754-2019, the Number value for every integer less than Number.MIN_SAFE_INTEGER is shared with at least one other integer. Such large-magnitude integers are therefore not safe, and are not guaranteed to be exactly representable as Number values or even to be distinguishable from each other. For example, both -9007199254740992 and -9007199254740993 evaluate to the Number value -9007199254740992𝔽.

The value of Number.MIN_SAFE_INTEGER is -9007199254740991𝔽 (𝔽(-(253 - 1))).

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: false }.

21.1.2.9 Number.MIN_VALUE

The value of Number.MIN_VALUE is the smallest positive value of the Number type, which is approximately 5 × 10-324.

In the IEEE 754-2019 double precision binary representation, the smallest possible value is a denormalized number. If an implementation does not support denormalized values, the value of Number.MIN_VALUE must be the smallest non-zero positive value that can actually be represented by the implementation.

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: false }.

21.1.2.10 Number.NaN

The value of Number.NaN is NaN.

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: false }.

21.1.2.11 Number.NEGATIVE_INFINITY

The value of Number.NEGATIVE_INFINITY is -∞𝔽.

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: false }.

21.1.2.12 Number.parseFloat ( string )

The initial value of the "parseFloat" property is %parseFloat%.

21.1.2.13 Number.parseInt ( string, radix )

The initial value of the "parseInt" property is %parseInt%.

21.1.2.14 Number.POSITIVE_INFINITY

The value of Number.POSITIVE_INFINITY is +∞𝔽.

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: false }.

21.1.2.15 Number.prototype

The initial value of Number.prototype is the Number prototype object.

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: false }.

21.1.3 Properties of the Number Prototype Object

The Number prototype object:

  • is %Number.prototype%.
  • is an ordinary object.
  • is itself a Number object; it has a [[NumberData]] internal slot with the value +0𝔽.
  • has a [[Prototype]] internal slot whose value is %Object.prototype%.

Unless explicitly stated otherwise, the methods of the Number prototype object defined below are not generic and the this value passed to them must be either a Number value or an object that has a [[NumberData]] internal slot that has been initialized to a Number value.

The phrase “this Number value” within the specification of a method refers to the result returned by calling the abstract operation ThisNumberValue with the this value of the method invocation passed as the argument.

21.1.3.1 Number.prototype.constructor

The initial value of Number.prototype.constructor is %Number%.

21.1.3.2 Number.prototype.toExponential ( fractionDigits )

This method returns a String containing this Number value represented in decimal exponential notation with one digit before the significand's decimal point and fractionDigits digits after the significand's decimal point. If fractionDigits is undefined, it includes as many significand digits as necessary to uniquely specify the Number (just like in ToString except that in this case the Number is always output in exponential notation).

It performs the following steps when called:

  1. Let x be ? ThisNumberValue(this value).
  2. Let f be ? ToIntegerOrInfinity(fractionDigits).
  3. Assert: If fractionDigits is undefined, then f is 0.
  4. If x is not finite, return Number::toString(x, 10).
  5. If f < 0 or f > 100, throw a RangeError exception.
  6. Set x to (x).
  7. Let s be the empty String.
  8. If x < 0, then
    1. Set s to "-".
    2. Set x to -x.
  9. If x = 0, then
    1. Let m be the String value consisting of f + 1 occurrences of the code unit 0x0030 (DIGIT ZERO).
    2. Let e be 0.
  10. Else,
    1. If fractionDigits is not undefined, then
      1. Let e and n be integers such that 10fn < 10f + 1 and for which n × 10e - f - x is as close to zero as possible. If there are two such sets of e and n, pick the e and n for which n × 10e - f is larger.
    2. Else,
      1. Let e, n, and ff be integers such that ff ≥ 0, 10ffn < 10ff + 1, 𝔽(n × 10e - ff) is 𝔽(x), and ff is as small as possible. Note that the decimal representation of n has ff + 1 digits, n is not divisible by 10, and the least significant digit of n is not necessarily uniquely determined by these criteria.
      2. Set f to ff.
    3. Let m be the String value consisting of the digits of the decimal representation of n (in order, with no leading zeroes).
  11. If f ≠ 0, then
    1. Let a be the first code unit of m.
    2. Let b be the other f code units of m.
    3. Set m to the string-concatenation of a, ".", and b.
  12. If e = 0, then
    1. Let c be "+".
    2. Let d be "0".
  13. Else,
    1. If e > 0, then
      1. Let c be "+".
    2. Else,
      1. Assert: e < 0.
      2. Let c be "-".
      3. Set e to -e.
    3. Let d be the String value consisting of the digits of the decimal representation of e (in order, with no leading zeroes).
  14. Set m to the string-concatenation of m, "e", c, and d.
  15. Return the string-concatenation of s and m.
Note

For implementations that provide more accurate conversions than required by the rules above, it is recommended that the following alternative version of step 10.b.i be used as a guideline:

  1. Let e, n, and f be integers such that f ≥ 0, 10fn < 10f + 1, 𝔽(n × 10e - f) is 𝔽(x), and f is as small as possible. If there are multiple possibilities for n, choose the value of n for which 𝔽(n × 10e - f) is closest in value to 𝔽(x). If there are two such possible values of n, choose the one that is even.

21.1.3.3 Number.prototype.toFixed ( fractionDigits )

Note 1

This method returns a String containing this Number value represented in decimal fixed-point notation with fractionDigits digits after the decimal point. If fractionDigits is undefined, 0 is assumed.

It performs the following steps when called:

  1. Let x be ? ThisNumberValue(this value).
  2. Let f be ? ToIntegerOrInfinity(fractionDigits).
  3. Assert: If fractionDigits is undefined, then f is 0.
  4. If f is not finite, throw a RangeError exception.
  5. If f < 0 or f > 100, throw a RangeError exception.
  6. If x is not finite, return Number::toString(x, 10).
  7. Set x to (x).
  8. Let s be the empty String.
  9. If x < 0, then
    1. Set s to "-".
    2. Set x to -x.
  10. If x ≥ 1021, then
    1. Let m be ! ToString(𝔽(x)).
  11. Else,
    1. Let n be an integer for which n / 10f - x is as close to zero as possible. If there are two such n, pick the larger n.
    2. If n = 0, let m be "0"; otherwise let m be the String value consisting of the digits of the decimal representation of n (in order, with no leading zeroes).
    3. If f ≠ 0, then
      1. Let k be the length of m.
      2. If kf, then
        1. Let z be the String value consisting of f + 1 - k occurrences of the code unit 0x0030 (DIGIT ZERO).
        2. Set m to the string-concatenation of z and m.
        3. Set k to f + 1.
      3. Let a be the first k - f code units of m.
      4. Let b be the other f code units of m.
      5. Set m to the string-concatenation of a, ".", and b.
  12. Return the string-concatenation of s and m.
Note 2

The output of toFixed may be more precise than toString for some values because toString only prints enough significant digits to distinguish the number from adjacent Number values. For example,

(1000000000000000128).toString() returns "1000000000000000100", while
(1000000000000000128).toFixed(0) returns "1000000000000000128".

21.1.3.4 Number.prototype.toLocaleString ( [ reserved1 [ , reserved2 ] ] )

An ECMAScript implementation that includes the ECMA-402 Internationalization API must implement this method as specified in the ECMA-402 specification. If an ECMAScript implementation does not include the ECMA-402 API the following specification of this method is used:

This method produces a String value that represents this Number value formatted according to the conventions of the host environment's current locale. This method is implementation-defined, and it is permissible, but not encouraged, for it to return the same thing as toString.

The meanings of the optional parameters to this method are defined in the ECMA-402 specification; implementations that do not include ECMA-402 support must not use those parameter positions for anything else.

21.1.3.5 Number.prototype.toPrecision ( precision )

This method returns a String containing this Number value represented either in decimal exponential notation with one digit before the significand's decimal point and precision - 1 digits after the significand's decimal point or in decimal fixed notation with precision significant digits. If precision is undefined, it calls ToString instead.

It performs the following steps when called:

  1. Let x be ? ThisNumberValue(this value).
  2. If precision is undefined, return ! ToString(x).
  3. Let p be ? ToIntegerOrInfinity(precision).
  4. If x is not finite, return Number::toString(x, 10).
  5. If p < 1 or p > 100, throw a RangeError exception.
  6. Set x to (x).
  7. Let s be the empty String.
  8. If x < 0, then
    1. Set s to the code unit 0x002D (HYPHEN-MINUS).
    2. Set x to -x.
  9. If x = 0, then
    1. Let m be the String value consisting of p occurrences of the code unit 0x0030 (DIGIT ZERO).
    2. Let e be 0.
  10. Else,
    1. Let e and n be integers such that 10p - 1n < 10p and for which n × 10e - p + 1 - x is as close to zero as possible. If there are two such sets of e and n, pick the e and n for which n × 10e - p + 1 is larger.
    2. Let m be the String value consisting of the digits of the decimal representation of n (in order, with no leading zeroes).
    3. If e < -6 or ep, then
      1. Assert: e ≠ 0.
      2. If p ≠ 1, then
        1. Let a be the first code unit of m.
        2. Let b be the other p - 1 code units of m.
        3. Set m to the string-concatenation of a, ".", and b.
      3. If e > 0, then
        1. Let c be the code unit 0x002B (PLUS SIGN).
      4. Else,
        1. Assert: e < 0.
        2. Let c be the code unit 0x002D (HYPHEN-MINUS).
        3. Set e to -e.
      5. Let d be the String value consisting of the digits of the decimal representation of e (in order, with no leading zeroes).
      6. Return the string-concatenation of s, m, the code unit 0x0065 (LATIN SMALL LETTER E), c, and d.
  11. If e = p - 1, return the string-concatenation of s and m.
  12. If e ≥ 0, then
    1. Set m to the string-concatenation of the first e + 1 code units of m, the code unit 0x002E (FULL STOP), and the remaining p - (e + 1) code units of m.
  13. Else,
    1. Set m to the string-concatenation of the code unit 0x0030 (DIGIT ZERO), the code unit 0x002E (FULL STOP), -(e + 1) occurrences of the code unit 0x0030 (DIGIT ZERO), and the String m.
  14. Return the string-concatenation of s and m.

21.1.3.6 Number.prototype.toString ( [ radix ] )

Note

The optional radix should be an integral Number value in the inclusive interval from 2𝔽 to 36𝔽. If radix is undefined then 10𝔽 is used as the value of radix.

This method performs the following steps when called:

  1. Let x be ? ThisNumberValue(this value).
  2. If radix is undefined, let radixMV be 10.
  3. Else, let radixMV be ? ToIntegerOrInfinity(radix).
  4. If radixMV is not in the inclusive interval from 2 to 36, throw a RangeError exception.
  5. Return Number::toString(x, radixMV).

This method is not generic; it throws a TypeError exception if its this value is not a Number or a Number object. Therefore, it cannot be transferred to other kinds of objects for use as a method.

The "length" property of this method is 1𝔽.

21.1.3.7 Number.prototype.valueOf ( )

  1. Return ? ThisNumberValue(this value).

21.1.3.7.1 ThisNumberValue ( value )

The abstract operation ThisNumberValue takes argument value (an ECMAScript language value) and returns either a normal completion containing a Number or a throw completion. It performs the following steps when called:

  1. If value is a Number, return value.
  2. If value is an Object and value has a [[NumberData]] internal slot, then
    1. Let n be value.[[NumberData]].
    2. Assert: n is a Number.
    3. Return n.
  3. Throw a TypeError exception.

21.1.4 Properties of Number Instances

Number instances are ordinary objects that inherit properties from the Number prototype object. Number instances also have a [[NumberData]] internal slot. The [[NumberData]] internal slot is the Number value represented by this Number object.

21.2 BigInt Objects

21.2.1 The BigInt Constructor

The BigInt constructor:

  • is %BigInt%.
  • is the initial value of the "BigInt" property of the global object.
  • performs a type conversion when called as a function rather than as a constructor.
  • is not intended to be used with the new operator or to be subclassed. It may be used as the value of an extends clause of a class definition but a super call to the BigInt constructor will cause an exception.

21.2.1.1 BigInt ( value )

This function performs the following steps when called:

  1. If NewTarget is not undefined, throw a TypeError exception.
  2. Let prim be ? ToPrimitive(value, number).
  3. If prim is a Number, return ? NumberToBigInt(prim).
  4. Otherwise, return ? ToBigInt(prim).

21.2.1.1.1 NumberToBigInt ( number )

The abstract operation NumberToBigInt takes argument number (a Number) and returns either a normal completion containing a BigInt or a throw completion. It performs the following steps when called:

  1. If number is not an integral Number, throw a RangeError exception.
  2. Return ((number)).

21.2.2 Properties of the BigInt Constructor

The BigInt constructor:

  • has a [[Prototype]] internal slot whose value is %Function.prototype%.
  • has the following properties:

21.2.2.1 BigInt.asIntN ( bits, bigint )

This function performs the following steps when called:

  1. Set bits to ? ToIndex(bits).
  2. Set bigint to ? ToBigInt(bigint).
  3. Let mod be (bigint) modulo 2bits.
  4. If mod ≥ 2bits - 1, return (mod - 2bits); otherwise return (mod).

21.2.2.2 BigInt.asUintN ( bits, bigint )

This function performs the following steps when called:

  1. Set bits to ? ToIndex(bits).
  2. Set bigint to ? ToBigInt(bigint).
  3. Return ((bigint) modulo 2bits).

21.2.2.3 BigInt.prototype

The initial value of BigInt.prototype is the BigInt prototype object.

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: false }.

21.2.3 Properties of the BigInt Prototype Object

The BigInt prototype object:

The phrase “this BigInt value” within the specification of a method refers to the result returned by calling the abstract operation ThisBigIntValue with the this value of the method invocation passed as the argument.

21.2.3.1 BigInt.prototype.constructor

The initial value of BigInt.prototype.constructor is %BigInt%.

21.2.3.2 BigInt.prototype.toLocaleString ( [ reserved1 [ , reserved2 ] ] )

An ECMAScript implementation that includes the ECMA-402 Internationalization API must implement this method as specified in the ECMA-402 specification. If an ECMAScript implementation does not include the ECMA-402 API the following specification of this method is used:

This method produces a String value that represents this BigInt value formatted according to the conventions of the host environment's current locale. This method is implementation-defined, and it is permissible, but not encouraged, for it to return the same thing as toString.

The meanings of the optional parameters to this method are defined in the ECMA-402 specification; implementations that do not include ECMA-402 support must not use those parameter positions for anything else.

21.2.3.3 BigInt.prototype.toString ( [ radix ] )

Note

The optional radix should be an integral Number value in the inclusive interval from 2𝔽 to 36𝔽. If radix is undefined then 10𝔽 is used as the value of radix.

This method performs the following steps when called:

  1. Let x be ? ThisBigIntValue(this value).
  2. If radix is undefined, let radixMV be 10.
  3. Else, let radixMV be ? ToIntegerOrInfinity(radix).
  4. If radixMV is not in the inclusive interval from 2 to 36, throw a RangeError exception.
  5. Return BigInt::toString(x, radixMV).

This method is not generic; it throws a TypeError exception if its this value is not a BigInt or a BigInt object. Therefore, it cannot be transferred to other kinds of objects for use as a method.

21.2.3.4 BigInt.prototype.valueOf ( )

  1. Return ? ThisBigIntValue(this value).

21.2.3.4.1 ThisBigIntValue ( value )

The abstract operation ThisBigIntValue takes argument value (an ECMAScript language value) and returns either a normal completion containing a BigInt or a throw completion. It performs the following steps when called:

  1. If value is a BigInt, return value.
  2. If value is an Object and value has a [[BigIntData]] internal slot, then
    1. Assert: value.[[BigIntData]] is a BigInt.
    2. Return value.[[BigIntData]].
  3. Throw a TypeError exception.

21.2.3.5 BigInt.prototype [ %Symbol.toStringTag% ]

The initial value of the %Symbol.toStringTag% property is the String value "BigInt".

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: true }.

21.2.4 Properties of BigInt Instances

BigInt instances are ordinary objects that inherit properties from the BigInt prototype object. BigInt instances also have a [[BigIntData]] internal slot. The [[BigIntData]] internal slot is the BigInt value represented by this BigInt object.

21.3 The Math Object

The Math object:

  • is %Math%.
  • is the initial value of the "Math" property of the global object.
  • is an ordinary object.
  • has a [[Prototype]] internal slot whose value is %Object.prototype%.
  • is not a function object.
  • does not have a [[Construct]] internal method; it cannot be used as a constructor with the new operator.
  • does not have a [[Call]] internal method; it cannot be invoked as a function.
Note

In this specification, the phrase “the Number value for x” has a technical meaning defined in 6.1.6.1.

21.3.1 Value Properties of the Math Object

21.3.1.1 Math.E

The Number value for e, the base of the natural logarithms, which is approximately 2.7182818284590452354.

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: false }.

21.3.1.2 Math.LN10

The Number value for the natural logarithm of 10, which is approximately 2.302585092994046.

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: false }.

21.3.1.3 Math.LN2

The Number value for the natural logarithm of 2, which is approximately 0.6931471805599453.

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: false }.

21.3.1.4 Math.LOG10E

The Number value for the base-10 logarithm of e, the base of the natural logarithms; this value is approximately 0.4342944819032518.

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: false }.

Note

The value of Math.LOG10E is approximately the reciprocal of the value of Math.LN10.

21.3.1.5 Math.LOG2E

The Number value for the base-2 logarithm of e, the base of the natural logarithms; this value is approximately 1.4426950408889634.

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: false }.

Note

The value of Math.LOG2E is approximately the reciprocal of the value of Math.LN2.

21.3.1.6 Math.PI

The Number value for π, the ratio of the circumference of a circle to its diameter, which is approximately 3.1415926535897932.

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: false }.

21.3.1.7 Math.SQRT1_2

The Number value for the square root of ½, which is approximately 0.7071067811865476.

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: false }.

Note

The value of Math.SQRT1_2 is approximately the reciprocal of the value of Math.SQRT2.

21.3.1.8 Math.SQRT2

The Number value for the square root of 2, which is approximately 1.4142135623730951.

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: false }.

21.3.1.9 Math [ %Symbol.toStringTag% ]

The initial value of the %Symbol.toStringTag% property is the String value "Math".

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: true }.

21.3.2 Function Properties of the Math Object

Note

The behaviour of the functions acos, acosh, asin, asinh, atan, atanh, atan2, cbrt, cos, cosh, exp, expm1, hypot, log, log1p, log2, log10, pow, random, sin, sinh, tan, and tanh is not precisely specified here except to require specific results for certain argument values that represent boundary cases of interest. For other argument values, these functions are intended to compute approximations to the results of familiar mathematical functions, but some latitude is allowed in the choice of approximation algorithms. The general intent is that an implementer should be able to use the same mathematical library for ECMAScript on a given hardware platform that is available to C programmers on that platform.

Although the choice of algorithms is left to the implementation, it is recommended (but not specified by this standard) that implementations use the approximation algorithms for IEEE 754-2019 arithmetic contained in fdlibm, the freely distributable mathematical library from Sun Microsystems (http://www.netlib.org/fdlibm).

21.3.2.1 Math.abs ( x )

This function returns the absolute value of x; the result has the same magnitude as x but has positive sign.

It performs the following steps when called:

  1. Let n be ? ToNumber(x).
  2. If n is NaN, return NaN.
  3. If n is -0𝔽, return +0𝔽.
  4. If n is -∞𝔽, return +∞𝔽.
  5. If n < -0𝔽, return -n.
  6. Return n.

21.3.2.2 Math.acos ( x )

This function returns the inverse cosine of x. The result is expressed in radians and is in the inclusive interval from +0𝔽 to 𝔽(π).

It performs the following steps when called:

  1. Let n be ? ToNumber(x).
  2. If n is NaN, n > 1𝔽, or n < -1𝔽, return NaN.
  3. If n is 1𝔽, return +0𝔽.
  4. Return an implementation-approximated Number value representing the inverse cosine of (n).

21.3.2.3 Math.acosh ( x )

This function returns the inverse hyperbolic cosine of x.

It performs the following steps when called:

  1. Let n be ? ToNumber(x).
  2. If n is either NaN or +∞𝔽, return n.
  3. If n is 1𝔽, return +0𝔽.
  4. If n < 1𝔽, return NaN.
  5. Return an implementation-approximated Number value representing the inverse hyperbolic cosine of (n).

21.3.2.4 Math.asin ( x )

This function returns the inverse sine of x. The result is expressed in radians and is in the inclusive interval from 𝔽(-π / 2) to 𝔽(π / 2).

It performs the following steps when called:

  1. Let n be ? ToNumber(x).
  2. If n is one of NaN, +0𝔽, or -0𝔽, return n.
  3. If n > 1𝔽 or n < -1𝔽, return NaN.
  4. Return an implementation-approximated Number value representing the inverse sine of (n).

21.3.2.5 Math.asinh ( x )

This function returns the inverse hyperbolic sine of x.

It performs the following steps when called:

  1. Let n be ? ToNumber(x).
  2. If n is not finite or n is either +0𝔽 or -0𝔽, return n.
  3. Return an implementation-approximated Number value representing the inverse hyperbolic sine of (n).

21.3.2.6 Math.atan ( x )

This function returns the inverse tangent of x. The result is expressed in radians and is in the inclusive interval from 𝔽(-π / 2) to 𝔽(π / 2).

It performs the following steps when called:

  1. Let n be ? ToNumber(x).
  2. If n is one of NaN, +0𝔽, or -0𝔽, return n.
  3. If n is +∞𝔽, return an implementation-approximated Number value representing π / 2.
  4. If n is -∞𝔽, return an implementation-approximated Number value representing -π / 2.
  5. Return an implementation-approximated Number value representing the inverse tangent of (n).

21.3.2.7 Math.atanh ( x )

This function returns the inverse hyperbolic tangent of x.

It performs the following steps when called:

  1. Let n be ? ToNumber(x).
  2. If n is one of NaN, +0𝔽, or -0𝔽, return n.
  3. If n > 1𝔽 or n < -1𝔽, return NaN.
  4. If n is 1𝔽, return +∞𝔽.
  5. If n is -1𝔽, return -∞𝔽.
  6. Return an implementation-approximated Number value representing the inverse hyperbolic tangent of (n).

21.3.2.8 Math.atan2 ( y, x )

This function returns the inverse tangent of the quotient y / x of the arguments y and x, where the signs of y and x are used to determine the quadrant of the result. Note that it is intentional and traditional for the two-argument inverse tangent function that the argument named y be first and the argument named x be second. The result is expressed in radians and is in the inclusive interval from -π to +π.

It performs the following steps when called:

  1. Let ny be ? ToNumber(y).
  2. Let nx be ? ToNumber(x).
  3. If ny is NaN or nx is NaN, return NaN.
  4. If ny is +∞𝔽, then
    1. If nx is +∞𝔽, return an implementation-approximated Number value representing π / 4.
    2. If nx is -∞𝔽, return an implementation-approximated Number value representing 3π / 4.
    3. Return an implementation-approximated Number value representing π / 2.
  5. If ny is -∞𝔽, then
    1. If nx is +∞𝔽, return an implementation-approximated Number value representing -π / 4.
    2. If nx is -∞𝔽, return an implementation-approximated Number value representing -3π / 4.
    3. Return an implementation-approximated Number value representing -π / 2.
  6. If ny is +0𝔽, then
    1. If nx > +0𝔽 or nx is +0𝔽, return +0𝔽.
    2. Return an implementation-approximated Number value representing π.
  7. If ny is -0𝔽, then
    1. If nx > +0𝔽 or nx is +0𝔽, return -0𝔽.
    2. Return an implementation-approximated Number value representing -π.
  8. Assert: ny is finite and is neither +0𝔽 nor -0𝔽.
  9. If ny > +0𝔽, then
    1. If nx is +∞𝔽, return +0𝔽.
    2. If nx is -∞𝔽, return an implementation-approximated Number value representing π.
    3. If nx is either +0𝔽 or -0𝔽, return an implementation-approximated Number value representing π / 2.
  10. If ny < -0𝔽, then
    1. If nx is +∞𝔽, return -0𝔽.
    2. If nx is -∞𝔽, return an implementation-approximated Number value representing -π.
    3. If nx is either +0𝔽 or -0𝔽, return an implementation-approximated Number value representing -π / 2.
  11. Assert: nx is finite and is neither +0𝔽 nor -0𝔽.
  12. Let r be the inverse tangent of abs((ny) / (nx)).
  13. If nx < -0𝔽, then
    1. If ny > +0𝔽, set r to π - r.
    2. Else, set r to -π + r.
  14. Else,
    1. If ny < -0𝔽, set r to -r.
  15. Return an implementation-approximated Number value representing r.

21.3.2.9 Math.cbrt ( x )

This function returns the cube root of x.

It performs the following steps when called:

  1. Let n be ? ToNumber(x).
  2. If n is not finite or n is either +0𝔽 or -0𝔽, return n.
  3. Return an implementation-approximated Number value representing the cube root of (n).

21.3.2.10 Math.ceil ( x )

This function returns the smallest (closest to -∞) integral Number value that is not less than x. If x is already an integral Number, the result is x.

It performs the following steps when called:

  1. Let n be ? ToNumber(x).
  2. If n is not finite or n is either +0𝔽 or -0𝔽, return n.
  3. If n < -0𝔽 and n > -1𝔽, return -0𝔽.
  4. If n is an integral Number, return n.
  5. Return the smallest (closest to -∞) integral Number value that is not less than n.
Note

The value of Math.ceil(x) is the same as the value of -Math.floor(-x).

21.3.2.11 Math.clz32 ( x )

This function performs the following steps when called:

  1. Let n be ? ToUint32(x).
  2. Let p be the number of leading zero bits in the unsigned 32-bit binary representation of n.
  3. Return 𝔽(p).
Note

If n is either +0𝔽 or -0𝔽, this method returns 32𝔽. If the most significant bit of the 32-bit binary encoding of n is 1, this method returns +0𝔽.

21.3.2.12 Math.cos ( x )

This function returns the cosine of x. The argument is expressed in radians.

It performs the following steps when called:

  1. Let n be ? ToNumber(x).
  2. If n is not finite, return NaN.
  3. If n is either +0𝔽 or -0𝔽, return 1𝔽.
  4. Return an implementation-approximated Number value representing the cosine of (n).

21.3.2.13 Math.cosh ( x )

This function returns the hyperbolic cosine of x.

It performs the following steps when called:

  1. Let n be ? ToNumber(x).
  2. If n is NaN, return NaN.
  3. If n is either +∞𝔽 or -∞𝔽, return +∞𝔽.
  4. If n is either +0𝔽 or -0𝔽, return 1𝔽.
  5. Return an implementation-approximated Number value representing the hyperbolic cosine of (n).
Note

The value of Math.cosh(x) is the same as the value of (Math.exp(x) + Math.exp(-x)) / 2.

21.3.2.14 Math.exp ( x )

This function returns the exponential function of x (e raised to the power of x, where e is the base of the natural logarithms).

It performs the following steps when called:

  1. Let n be ? ToNumber(x).
  2. If n is either NaN or +∞𝔽, return n.
  3. If n is either +0𝔽 or -0𝔽, return 1𝔽.
  4. If n is -∞𝔽, return +0𝔽.
  5. Return an implementation-approximated Number value representing the exponential function of (n).

21.3.2.15 Math.expm1 ( x )

This function returns the result of subtracting 1 from the exponential function of x (e raised to the power of x, where e is the base of the natural logarithms). The result is computed in a way that is accurate even when the value of x is close to 0.

It performs the following steps when called:

  1. Let n be ? ToNumber(x).
  2. If n is one of NaN, +0𝔽, -0𝔽, or +∞𝔽, return n.
  3. If n is -∞𝔽, return -1𝔽.
  4. Let exp be the exponential function of (n).
  5. Return an implementation-approximated Number value representing exp - 1.

21.3.2.16 Math.floor ( x )

This function returns the greatest (closest to +∞) integral Number value that is not greater than x. If x is already an integral Number, the result is x.

It performs the following steps when called:

  1. Let n be ? ToNumber(x).
  2. If n is not finite or n is either +0𝔽 or -0𝔽, return n.
  3. If n < 1𝔽 and n > +0𝔽, return +0𝔽.
  4. If n is an integral Number, return n.
  5. Return the greatest (closest to +∞) integral Number value that is not greater than n.
Note

The value of Math.floor(x) is the same as the value of -Math.ceil(-x).

21.3.2.17 Math.fround ( x )

This function performs the following steps when called:

  1. Let n be ? ToNumber(x).
  2. If n is NaN, return NaN.
  3. If n is one of +0𝔽, -0𝔽, +∞𝔽, or -∞𝔽, return n.
  4. Let n32 be the result of converting n to IEEE 754-2019 binary32 format using roundTiesToEven mode.
  5. Let n64 be the result of converting n32 to IEEE 754-2019 binary64 format.
  6. Return the ECMAScript Number value corresponding to n64.

21.3.2.18 Math.f16round ( x )

This function performs the following steps when called:

  1. Let n be ? ToNumber(x).
  2. If n is NaN, return NaN.
  3. If n is one of +0𝔽, -0𝔽, +∞𝔽, or -∞𝔽, return n.
  4. Let n16 be the result of converting n to IEEE 754-2019 binary16 format using roundTiesToEven mode.
  5. Let n64 be the result of converting n16 to IEEE 754-2019 binary64 format.
  6. Return the ECMAScript Number value corresponding to n64.
Note

This operation is not the same as casting to binary32 and then to binary16 because of the possibility of double-rounding: consider the number k = 1.00048828125000022204𝔽, for example, for which Math.f16round(k) is 1.0009765625𝔽, but Math.f16round(Math.fround(k)) is 1𝔽.

Not all platforms provide native support for casting from binary64 to binary16. There are various libraries which can provide this, including the MIT-licensed half library. Alternatively, it is possible to first cast from binary64 to binary32 under roundTiesToEven and then check whether the result could lead to incorrect double-rounding. The cases which could can be handled explicitly by adjusting the mantissa of the binary32 value so that it is the value which would be produced by performing the initial cast under roundTiesToOdd. Casting the adjusted value to binary16 under roundTiesToEven then produces the correct value.

21.3.2.19 Math.hypot ( ...args )

Given zero or more arguments, this function returns the square root of the sum of squares of its arguments.

It performs the following steps when called:

  1. Let coerced be a new empty List.
  2. For each element arg of args, do
    1. Let n be ? ToNumber(arg).
    2. Append n to coerced.
  3. For each element number of coerced, do
    1. If number is either +∞𝔽 or -∞𝔽, return +∞𝔽.
  4. Let onlyZero be true.
  5. For each element number of coerced, do
    1. If number is NaN, return NaN.
    2. If number is neither +0𝔽 nor -0𝔽, set onlyZero to false.
  6. If onlyZero is true, return +0𝔽.
  7. Return an implementation-approximated Number value representing the square root of the sum of squares of the mathematical values of the elements of coerced.

The "length" property of this function is 2𝔽.

Note

Implementations should take care to avoid the loss of precision from overflows and underflows that are prone to occur in naive implementations when this function is called with two or more arguments.

21.3.2.20 Math.imul ( x, y )

This function performs the following steps when called:

  1. Let a be (? ToUint32(x)).
  2. Let b be (? ToUint32(y)).
  3. Let product be (a × b) modulo 232.
  4. If product ≥ 231, return 𝔽(product - 232); otherwise return 𝔽(product).

21.3.2.21 Math.log ( x )

This function returns the natural logarithm of x.

It performs the following steps when called:

  1. Let n be ? ToNumber(x).
  2. If n is either NaN or +∞𝔽, return n.
  3. If n is 1𝔽, return +0𝔽.
  4. If n is either +0𝔽 or -0𝔽, return -∞𝔽.
  5. If n < -0𝔽, return NaN.
  6. Return an implementation-approximated Number value representing the natural logarithm of (n).

21.3.2.22 Math.log1p ( x )

This function returns the natural logarithm of 1 + x. The result is computed in a way that is accurate even when the value of x is close to zero.

It performs the following steps when called:

  1. Let n be ? ToNumber(x).
  2. If n is one of NaN, +0𝔽, -0𝔽, or +∞𝔽, return n.
  3. If n is -1𝔽, return -∞𝔽.
  4. If n < -1𝔽, return NaN.
  5. Return an implementation-approximated Number value representing the natural logarithm of 1 + (n).

21.3.2.23 Math.log10 ( x )

This function returns the base 10 logarithm of x.

It performs the following steps when called:

  1. Let n be ? ToNumber(x).
  2. If n is either NaN or +∞𝔽, return n.
  3. If n is 1𝔽, return +0𝔽.
  4. If n is either +0𝔽 or -0𝔽, return -∞𝔽.
  5. If n < -0𝔽, return NaN.
  6. Return an implementation-approximated Number value representing the base 10 logarithm of (n).

21.3.2.24 Math.log2 ( x )

This function returns the base 2 logarithm of x.

It performs the following steps when called:

  1. Let n be ? ToNumber(x).
  2. If n is either NaN or +∞𝔽, return n.
  3. If n is 1𝔽, return +0𝔽.
  4. If n is either +0𝔽 or -0𝔽, return -∞𝔽.
  5. If n < -0𝔽, return NaN.
  6. Return an implementation-approximated Number value representing the base 2 logarithm of (n).

21.3.2.25 Math.max ( ...args )

Given zero or more arguments, this function calls ToNumber on each of the arguments and returns the largest of the resulting values.

It performs the following steps when called:

  1. Let coerced be a new empty List.
  2. For each element arg of args, do
    1. Let n be ? ToNumber(arg).
    2. Append n to coerced.
  3. Let highest be -∞𝔽.
  4. For each element number of coerced, do
    1. If number is NaN, return NaN.
    2. If number is +0𝔽 and highest is -0𝔽, set highest to +0𝔽.
    3. If number > highest, set highest to number.
  5. Return highest.
Note

The comparison of values to determine the largest value is done using the IsLessThan algorithm except that +0𝔽 is considered to be larger than -0𝔽.

The "length" property of this function is 2𝔽.

21.3.2.26 Math.min ( ...args )

Given zero or more arguments, this function calls ToNumber on each of the arguments and returns the smallest of the resulting values.

It performs the following steps when called:

  1. Let coerced be a new empty List.
  2. For each element arg of args, do
    1. Let n be ? ToNumber(arg).
    2. Append n to coerced.
  3. Let lowest be +∞𝔽.
  4. For each element number of coerced, do
    1. If number is NaN, return NaN.
    2. If number is -0𝔽 and lowest is +0𝔽, set lowest to -0𝔽.
    3. If number < lowest, set lowest to number.
  5. Return lowest.
Note

The comparison of values to determine the largest value is done using the IsLessThan algorithm except that +0𝔽 is considered to be larger than -0𝔽.

The "length" property of this function is 2𝔽.

21.3.2.27 Math.pow ( base, exponent )

This function performs the following steps when called:

  1. Set base to ? ToNumber(base).
  2. Set exponent to ? ToNumber(exponent).
  3. Return Number::exponentiate(base, exponent).

21.3.2.28 Math.random ( )

This function returns a Number value with positive sign, greater than or equal to +0𝔽 but strictly less than 1𝔽, chosen randomly or pseudo randomly with approximately uniform distribution over that range, using an implementation-defined algorithm or strategy.

Each Math.random function created for distinct realms must produce a distinct sequence of values from successive calls.

21.3.2.29 Math.round ( x )

This function returns the Number value that is closest to x and is integral. If two integral Numbers are equally close to x, then the result is the Number value that is closer to +∞. If x is already integral, the result is x.

It performs the following steps when called:

  1. Let n be ? ToNumber(x).
  2. If n is not finite or n is an integral Number, return n.
  3. If n < 0.5𝔽 and n > +0𝔽, return +0𝔽.
  4. If n < -0𝔽 and n-0.5𝔽, return -0𝔽.
  5. Return the integral Number closest to n, preferring the Number closer to +∞ in the case of a tie.
Note 1

Math.round(3.5) returns 4, but Math.round(-3.5) returns -3.

Note 2

The value of Math.round(x) is not always the same as the value of Math.floor(x + 0.5). When x is -0𝔽 or x is less than -0𝔽 but greater than or equal to -0.5𝔽, Math.round(x) returns -0𝔽, but Math.floor(x + 0.5) returns +0𝔽. Math.round(x) may also differ from the value of Math.floor(x + 0.5)because of internal rounding when computing x + 0.5.

21.3.2.30 Math.sign ( x )

This function returns the sign of x, indicating whether x is positive, negative, or zero.

It performs the following steps when called:

  1. Let n be ? ToNumber(x).
  2. If n is one of NaN, +0𝔽, or -0𝔽, return n.
  3. If n < -0𝔽, return -1𝔽.
  4. Return 1𝔽.

21.3.2.31 Math.sin ( x )

This function returns the sine of x. The argument is expressed in radians.

It performs the following steps when called:

  1. Let n be ? ToNumber(x).
  2. If n is one of NaN, +0𝔽, or -0𝔽, return n.
  3. If n is either +∞𝔽 or -∞𝔽, return NaN.
  4. Return an implementation-approximated Number value representing the sine of (n).

21.3.2.32 Math.sinh ( x )

This function returns the hyperbolic sine of x.

It performs the following steps when called:

  1. Let n be ? ToNumber(x).
  2. If n is not finite or n is either +0𝔽 or -0𝔽, return n.
  3. Return an implementation-approximated Number value representing the hyperbolic sine of (n).
Note

The value of Math.sinh(x) is the same as the value of (Math.exp(x) - Math.exp(-x)) / 2.

21.3.2.33 Math.sqrt ( x )

This function returns the square root of x.

It performs the following steps when called:

  1. Let n be ? ToNumber(x).
  2. If n is one of NaN, +0𝔽, -0𝔽, or +∞𝔽, return n.
  3. If n < -0𝔽, return NaN.
  4. Return 𝔽(the square root of (n)).

21.3.2.34 Math.tan ( x )

This function returns the tangent of x. The argument is expressed in radians.

It performs the following steps when called:

  1. Let n be ? ToNumber(x).
  2. If n is one of NaN, +0𝔽, or -0𝔽, return n.
  3. If n is either +∞𝔽 or -∞𝔽, return NaN.
  4. Return an implementation-approximated Number value representing the tangent of (n).

21.3.2.35 Math.tanh ( x )

This function returns the hyperbolic tangent of x.

It performs the following steps when called:

  1. Let n be ? ToNumber(x).
  2. If n is one of NaN, +0𝔽, or -0𝔽, return n.
  3. If n is +∞𝔽, return 1𝔽.
  4. If n is -∞𝔽, return -1𝔽.
  5. Return an implementation-approximated Number value representing the hyperbolic tangent of (n).
Note

The value of Math.tanh(x) is the same as the value of (Math.exp(x) - Math.exp(-x)) / (Math.exp(x) + Math.exp(-x)).

21.3.2.36 Math.trunc ( x )

This function returns the integral part of the number x, removing any fractional digits. If x is already integral, the result is x.

It performs the following steps when called:

  1. Let n be ? ToNumber(x).
  2. If n is not finite or n is either +0𝔽 or -0𝔽, return n.
  3. If n < 1𝔽 and n > +0𝔽, return +0𝔽.
  4. If n < -0𝔽 and n > -1𝔽, return -0𝔽.
  5. Return the integral Number nearest n in the direction of +0𝔽.

21.4 Date Objects

21.4.1 Overview of Date Objects and Definitions of Abstract Operations

The following abstract operations operate on time values (defined in 21.4.1.1). Note that, in every case, if any argument to one of these functions is NaN, the result will be NaN.

21.4.1.1 Time Values and Time Range

Time measurement in ECMAScript is analogous to time measurement in POSIX, in particular sharing definition in terms of the proleptic Gregorian calendar, an epoch of midnight at the beginning of 1 January 1970 UTC, and an accounting of every day as comprising exactly 86,400 seconds (each of which is 1000 milliseconds long).

An ECMAScript time value is a Number, either a finite integral Number representing an instant in time to millisecond precision or NaN representing no specific instant. A time value that is a multiple of 24 × 60 × 60 × 1000 = 86,400,000 (i.e., is 86,400,000 × d for some integer d) represents the instant at the start of the UTC day that follows the epoch by d whole UTC days (preceding the epoch for negative d). Every other finite time value t is defined relative to the greatest preceding time value s that is such a multiple, and represents the instant that occurs within the same UTC day as s but follows it by (t - s) milliseconds.

Time values do not account for UTC leap seconds—there are no time values representing instants within positive leap seconds, and there are time values representing instants removed from the UTC timeline by negative leap seconds. However, the definition of time values nonetheless yields piecewise alignment with UTC, with discontinuities only at leap second boundaries and zero difference outside of leap seconds.

A Number can exactly represent all integers from -9,007,199,254,740,992 to 9,007,199,254,740,992 (21.1.2.8 and 21.1.2.6). A time value supports a slightly smaller range of -8,640,000,000,000,000 to 8,640,000,000,000,000 milliseconds. This yields a supported time value range of exactly -100,000,000 days to 100,000,000 days relative to midnight at the beginning of 1 January 1970 UTC.

The exact moment of midnight at the beginning of 1 January 1970 UTC is represented by the time value +0𝔽.

Note

In the proleptic Gregorian calendar, leap years are precisely those which are both divisible by 4 and either divisible by 400 or not divisible by 100.

The 400 year cycle of the proleptic Gregorian calendar contains 97 leap years. This yields an average of 365.2425 days per year, which is 31,556,952,000 milliseconds. Therefore, the maximum range a Number could represent exactly with millisecond precision is approximately -285,426 to 285,426 years relative to 1970. The smaller range supported by a time value as specified in this section is approximately -273,790 to 273,790 years relative to 1970.

21.4.1.2 Time-related Constants

These constants are referenced by algorithms in the following sections.

HoursPerDay = 24
MinutesPerHour = 60
SecondsPerMinute = 60
msPerSecond = 1000𝔽
msPerMinute = 60000𝔽 = msPerSecond × 𝔽(SecondsPerMinute)
msPerHour = 3600000𝔽 = msPerMinute × 𝔽(MinutesPerHour)
msPerDay = 86400000𝔽 = msPerHour × 𝔽(HoursPerDay)

21.4.1.3 Day ( t )

The abstract operation Day takes argument t (a finite time value) and returns an integral Number. It returns the day number of the day in which t falls. It performs the following steps when called:

  1. Return 𝔽(floor((t / msPerDay))).

21.4.1.4 TimeWithinDay ( t )

The abstract operation TimeWithinDay takes argument t (a finite time value) and returns an integral Number in the interval from +0𝔽 (inclusive) to msPerDay (exclusive). It returns the number of milliseconds since the start of the day in which t falls. It performs the following steps when called:

  1. Return 𝔽((t) modulo (msPerDay)).

21.4.1.5 DaysInYear ( y )

The abstract operation DaysInYear takes argument y (an integral Number) and returns 365𝔽 or 366𝔽. It returns the number of days in year y. Leap years have 366 days; all other years have 365. It performs the following steps when called:

  1. Let ry be (y).
  2. If (ry modulo 400) = 0, return 366𝔽.
  3. If (ry modulo 100) = 0, return 365𝔽.
  4. If (ry modulo 4) = 0, return 366𝔽.
  5. Return 365𝔽.

21.4.1.6 DayFromYear ( y )

The abstract operation DayFromYear takes argument y (an integral Number) and returns an integral Number. It returns the day number of the first day of year y. It performs the following steps when called:

  1. Let ry be (y).
  2. NOTE: In the following steps, numYears1, numYears4, numYears100, and numYears400 represent the number of years divisible by 1, 4, 100, and 400, respectively, that occur between the epoch and the start of year y. The number is negative if y is before the epoch.
  3. Let numYears1 be (ry - 1970).
  4. Let numYears4 be floor((ry - 1969) / 4).
  5. Let numYears100 be floor((ry - 1901) / 100).
  6. Let numYears400 be floor((ry - 1601) / 400).
  7. Return 𝔽(365 × numYears1 + numYears4 - numYears100 + numYears400).

21.4.1.7 TimeFromYear ( y )

The abstract operation TimeFromYear takes argument y (an integral Number) and returns a time value. It returns the time value of the start of year y. It performs the following steps when called:

  1. Return msPerDay × DayFromYear(y).

21.4.1.8 YearFromTime ( t )

The abstract operation YearFromTime takes argument t (a finite time value) and returns an integral Number. It returns the year in which t falls. It performs the following steps when called:

  1. Return the largest integral Number y (closest to +∞) such that TimeFromYear(y) ≤ t.

21.4.1.9 DayWithinYear ( t )

The abstract operation DayWithinYear takes argument t (a finite time value) and returns an integral Number in the inclusive interval from +0𝔽 to 365𝔽. It performs the following steps when called:

  1. Return Day(t) - DayFromYear(YearFromTime(t)).

21.4.1.10 InLeapYear ( t )

The abstract operation InLeapYear takes argument t (a finite time value) and returns +0𝔽 or 1𝔽. It returns 1𝔽 if t is within a leap year and +0𝔽 otherwise. It performs the following steps when called:

  1. If DaysInYear(YearFromTime(t)) is 366𝔽, return 1𝔽; else return +0𝔽.

21.4.1.11 MonthFromTime ( t )

The abstract operation MonthFromTime takes argument t (a finite time value) and returns an integral Number in the inclusive interval from +0𝔽 to 11𝔽. It returns a Number identifying the month in which t falls. A month value of +0𝔽 specifies January; 1𝔽 specifies February; 2𝔽 specifies March; 3𝔽 specifies April; 4𝔽 specifies May; 5𝔽 specifies June; 6𝔽 specifies July; 7𝔽 specifies August; 8𝔽 specifies September; 9𝔽 specifies October; 10𝔽 specifies November; and 11𝔽 specifies December. Note that MonthFromTime(+0𝔽) = +0𝔽, corresponding to Thursday, 1 January 1970. It performs the following steps when called:

  1. Let inLeapYear be InLeapYear(t).
  2. Let dayWithinYear be DayWithinYear(t).
  3. If dayWithinYear < 31𝔽, return +0𝔽.
  4. If dayWithinYear < 59𝔽 + inLeapYear, return 1𝔽.
  5. If dayWithinYear < 90𝔽 + inLeapYear, return 2𝔽.
  6. If dayWithinYear < 120𝔽 + inLeapYear, return 3𝔽.
  7. If dayWithinYear < 151𝔽 + inLeapYear, return 4𝔽.
  8. If dayWithinYear < 181𝔽 + inLeapYear, return 5𝔽.
  9. If dayWithinYear < 212𝔽 + inLeapYear, return 6𝔽.
  10. If dayWithinYear < 243𝔽 + inLeapYear, return 7𝔽.
  11. If dayWithinYear < 273𝔽 + inLeapYear, return 8𝔽.
  12. If dayWithinYear < 304𝔽 + inLeapYear, return 9𝔽.
  13. If dayWithinYear < 334𝔽 + inLeapYear, return 10𝔽.
  14. Assert: dayWithinYear < 365𝔽 + inLeapYear.
  15. Return 11𝔽.

21.4.1.12 DateFromTime ( t )

The abstract operation DateFromTime takes argument t (a finite time value) and returns an integral Number in the inclusive interval from 1𝔽 to 31𝔽. It returns the day of the month in which t falls. It performs the following steps when called:

  1. Let inLeapYear be InLeapYear(t).
  2. Let dayWithinYear be DayWithinYear(t).
  3. Let month be MonthFromTime(t).
  4. If month is +0𝔽, return dayWithinYear + 1𝔽.
  5. If month is 1𝔽, return dayWithinYear - 30𝔽.
  6. If month is 2𝔽, return dayWithinYear - 58𝔽 - inLeapYear.
  7. If month is 3𝔽, return dayWithinYear - 89𝔽 - inLeapYear.
  8. If month is 4𝔽, return dayWithinYear - 119𝔽 - inLeapYear.
  9. If month is 5𝔽, return dayWithinYear - 150𝔽 - inLeapYear.
  10. If month is 6𝔽, return dayWithinYear - 180𝔽 - inLeapYear.
  11. If month is 7𝔽, return dayWithinYear - 211𝔽 - inLeapYear.
  12. If month is 8𝔽, return dayWithinYear - 242𝔽 - inLeapYear.
  13. If month is 9𝔽, return dayWithinYear - 272𝔽 - inLeapYear.
  14. If month is 10𝔽, return dayWithinYear - 303𝔽 - inLeapYear.
  15. Assert: month is 11𝔽.
  16. Return dayWithinYear - 333𝔽 - inLeapYear.

21.4.1.13 WeekDay ( t )

The abstract operation WeekDay takes argument t (a finite time value) and returns an integral Number in the inclusive interval from +0𝔽 to 6𝔽. It returns a Number identifying the day of the week in which t falls. A weekday value of +0𝔽 specifies Sunday; 1𝔽 specifies Monday; 2𝔽 specifies Tuesday; 3𝔽 specifies Wednesday; 4𝔽 specifies Thursday; 5𝔽 specifies Friday; and 6𝔽 specifies Saturday. Note that WeekDay(+0𝔽) = 4𝔽, corresponding to Thursday, 1 January 1970. It performs the following steps when called:

  1. Return 𝔽((Day(t) + 4𝔽) modulo 7).

21.4.1.14 HourFromTime ( t )

The abstract operation HourFromTime takes argument t (a finite time value) and returns an integral Number in the inclusive interval from +0𝔽 to 23𝔽. It returns the hour of the day in which t falls. It performs the following steps when called:

  1. Return 𝔽(floor((t / msPerHour)) modulo HoursPerDay).

21.4.1.15 MinFromTime ( t )

The abstract operation MinFromTime takes argument t (a finite time value) and returns an integral Number in the inclusive interval from +0𝔽 to 59𝔽. It returns the minute of the hour in which t falls. It performs the following steps when called:

  1. Return 𝔽(floor((t / msPerMinute)) modulo MinutesPerHour).

21.4.1.16 SecFromTime ( t )

The abstract operation SecFromTime takes argument t (a finite time value) and returns an integral Number in the inclusive interval from +0𝔽 to 59𝔽. It returns the second of the minute in which t falls. It performs the following steps when called:

  1. Return 𝔽(floor((t / msPerSecond)) modulo SecondsPerMinute).

21.4.1.17 msFromTime ( t )

The abstract operation msFromTime takes argument t (a finite time value) and returns an integral Number in the inclusive interval from +0𝔽 to 999𝔽. It returns the millisecond of the second in which t falls. It performs the following steps when called:

  1. Return 𝔽((t) modulo (msPerSecond)).

21.4.1.18 GetUTCEpochNanoseconds ( year, month, day, hour, minute, second, millisecond, microsecond, nanosecond )

The abstract operation GetUTCEpochNanoseconds takes arguments year (an integer), month (an integer in the inclusive interval from 1 to 12), day (an integer in the inclusive interval from 1 to 31), hour (an integer in the inclusive interval from 0 to 23), minute (an integer in the inclusive interval from 0 to 59), second (an integer in the inclusive interval from 0 to 59), millisecond (an integer in the inclusive interval from 0 to 999), microsecond (an integer in the inclusive interval from 0 to 999), and nanosecond (an integer in the inclusive interval from 0 to 999) and returns a BigInt. The returned value represents a number of nanoseconds since the epoch that corresponds to the given ISO 8601 calendar date and wall-clock time in UTC. It performs the following steps when called:

  1. Let date be MakeDay(𝔽(year), 𝔽(month - 1), 𝔽(day)).
  2. Let time be MakeTime(𝔽(hour), 𝔽(minute), 𝔽(second), 𝔽(millisecond)).
  3. Let ms be MakeDate(date, time).
  4. Assert: ms is an integral Number.
  5. Return ((ms) × 106 + microsecond × 103 + nanosecond).

21.4.1.19 Time Zone Identifiers

Time zones in ECMAScript are represented by time zone identifiers, which are Strings composed entirely of code units in the inclusive interval from 0x0000 to 0x007F. Time zones supported by an ECMAScript implementation may be available named time zones, represented by the [[Identifier]] field of the Time Zone Identifier Records returned by AvailableNamedTimeZoneIdentifiers, or offset time zones, represented by Strings for which IsTimeZoneOffsetString returns true.

A primary time zone identifier is the preferred identifier for an available named time zone. A non-primary time zone identifier is an identifier for an available named time zone that is not a primary time zone identifier. An available named time zone identifier is either a primary time zone identifier or a non-primary time zone identifier. Each available named time zone identifier is associated with exactly one available named time zone. Each available named time zone is associated with exactly one primary time zone identifier and zero or more non-primary time zone identifiers.

ECMAScript implementations must support an available named time zone with the identifier "UTC", which must be the primary time zone identifier for the UTC time zone. In addition, implementations may support any number of other available named time zones.

Implementations that follow the requirements for time zones as described in the ECMA-402 Internationalization API specification are called time zone aware. Time zone aware implementations must support available named time zones corresponding to the Zone and Link names of the IANA Time Zone Database, and only such names. In time zone aware implementations, a primary time zone identifier is a Zone name, and a non-primary time zone identifier is a Link name, respectively, in the IANA Time Zone Database except as specifically overridden by AvailableNamedTimeZoneIdentifiers as specified in the ECMA-402 specification. Implementations that do not support the entire IANA Time Zone Database are still recommended to use IANA Time Zone Database names as identifiers to represent time zones.

21.4.1.20 GetNamedTimeZoneEpochNanoseconds ( timeZoneIdentifier, year, month, day, hour, minute, second, millisecond, microsecond, nanosecond )

The implementation-defined abstract operation GetNamedTimeZoneEpochNanoseconds takes arguments timeZoneIdentifier (a String), year (an integer), month (an integer in the inclusive interval from 1 to 12), day (an integer in the inclusive interval from 1 to 31), hour (an integer in the inclusive interval from 0 to 23), minute (an integer in the inclusive interval from 0 to 59), second (an integer in the inclusive interval from 0 to 59), millisecond (an integer in the inclusive interval from 0 to 999), microsecond (an integer in the inclusive interval from 0 to 999), and nanosecond (an integer in the inclusive interval from 0 to 999) and returns a List of BigInts. Each value in the returned List represents a number of nanoseconds since the epoch that corresponds to the given ISO 8601 calendar date and wall-clock time in the named time zone identified by timeZoneIdentifier.

When the input represents a local time occurring more than once because of a negative time zone transition (e.g. when daylight saving time ends or the time zone offset is decreased due to a time zone rule change), the returned List will have more than one element and will be sorted by ascending numerical value. When the input represents a local time skipped because of a positive time zone transition (e.g. when daylight saving time begins or the time zone offset is increased due to a time zone rule change), the returned List will be empty. Otherwise, the returned List will have one element.

The default implementation of GetNamedTimeZoneEpochNanoseconds, to be used for ECMAScript implementations that do not include local political rules for any time zones, performs the following steps when called:

  1. Assert: timeZoneIdentifier is "UTC".
  2. Let epochNanoseconds be GetUTCEpochNanoseconds(year, month, day, hour, minute, second, millisecond, microsecond, nanosecond).
  3. Return « epochNanoseconds ».
Note

It is required for time zone aware implementations (and recommended for all others) to use the time zone information of the IANA Time Zone Database https://www.iana.org/time-zones/.

1:30 AM on 5 November 2017 in America/New_York is repeated twice, so GetNamedTimeZoneEpochNanoseconds("America/New_York", 2017, 11, 5, 1, 30, 0, 0, 0, 0) would return a List of length 2 in which the first element represents 05:30 UTC (corresponding with 01:30 US Eastern Daylight Time at UTC offset -04:00) and the second element represents 06:30 UTC (corresponding with 01:30 US Eastern Standard Time at UTC offset -05:00).

2:30 AM on 12 March 2017 in America/New_York does not exist, so GetNamedTimeZoneEpochNanoseconds("America/New_York", 2017, 3, 12, 2, 30, 0, 0, 0, 0) would return an empty List.

21.4.1.21 GetNamedTimeZoneOffsetNanoseconds ( timeZoneIdentifier, epochNanoseconds )

The implementation-defined abstract operation GetNamedTimeZoneOffsetNanoseconds takes arguments timeZoneIdentifier (a String) and epochNanoseconds (a BigInt) and returns an integer.

The returned integer represents the offset from UTC of the named time zone identified by timeZoneIdentifier, at the instant corresponding with epochNanoseconds relative to the epoch, both in nanoseconds.

The default implementation of GetNamedTimeZoneOffsetNanoseconds, to be used for ECMAScript implementations that do not include local political rules for any time zones, performs the following steps when called:

  1. Assert: timeZoneIdentifier is "UTC".
  2. Return 0.
Note

Time zone offset values may be positive or negative.

21.4.1.22 Time Zone Identifier Record

A Time Zone Identifier Record is a Record used to describe an available named time zone identifier and its corresponding primary time zone identifier.

Time Zone Identifier Records have the fields listed in Table 64.

Table 64: Time Zone Identifier Record Fields
Field Name Value Meaning
[[Identifier]] a String An available named time zone identifier that is supported by the implementation.
[[PrimaryIdentifier]] a String The primary time zone identifier that [[Identifier]] resolves to.
Note

If [[Identifier]] is a primary time zone identifier, then [[Identifier]] is [[PrimaryIdentifier]].

21.4.1.23 AvailableNamedTimeZoneIdentifiers ( )

The implementation-defined abstract operation AvailableNamedTimeZoneIdentifiers takes no arguments and returns a List of Time Zone Identifier Records. Its result describes all available named time zone identifiers in this implementation, as well as the primary time zone identifier corresponding to each available named time zone identifier. The List is ordered according to the [[Identifier]] field of each Time Zone Identifier Record.

Time zone aware implementations, including all implementations that implement the ECMA-402 Internationalization API, must implement the AvailableNamedTimeZoneIdentifiers abstract operation as specified in the ECMA-402 specification. For implementations that are not time zone aware, AvailableNamedTimeZoneIdentifiers performs the following steps when called:

  1. If the implementation does not include local political rules for any time zones, then
    1. Return « the Time Zone Identifier Record { [[Identifier]]: "UTC", [[PrimaryIdentifier]]: "UTC" } ».
  2. Let identifiers be the List of unique available named time zone identifiers, sorted according to lexicographic code unit order.
  3. Let result be a new empty List.
  4. For each element identifier of identifiers, do
    1. Let primary be identifier.
    2. If identifier is a non-primary time zone identifier in this implementation and identifier is not "UTC", then
      1. Set primary to the primary time zone identifier associated with identifier.
      2. NOTE: An implementation may need to resolve identifier iteratively to obtain the primary time zone identifier.
    3. Let record be the Time Zone Identifier Record { [[Identifier]]: identifier, [[PrimaryIdentifier]]: primary }.
    4. Append record to result.
  5. Assert: result contains a Time Zone Identifier Record r such that r.[[Identifier]] is "UTC" and r.[[PrimaryIdentifier]] is "UTC".
  6. Return result.

21.4.1.24 SystemTimeZoneIdentifier ( )

The implementation-defined abstract operation SystemTimeZoneIdentifier takes no arguments and returns a String. It returns a String representing the host environment's current time zone, which is either a String representing a UTC offset for which IsTimeZoneOffsetString returns true, or a primary time zone identifier. It performs the following steps when called:

  1. If the implementation only supports the UTC time zone, return "UTC".
  2. Let systemTimeZoneString be the String representing the host environment's current time zone, either a primary time zone identifier or an offset time zone identifier.
  3. Return systemTimeZoneString.
Note

To ensure the level of functionality that implementations commonly provide in the methods of the Date object, it is recommended that SystemTimeZoneIdentifier return an IANA time zone name corresponding to the host environment's time zone setting, if such a thing exists. GetNamedTimeZoneEpochNanoseconds and GetNamedTimeZoneOffsetNanoseconds must reflect the local political rules for standard time and daylight saving time in that time zone, if such rules exist.

For example, if the host environment is a browser on a system where the user has chosen US Eastern Time as their time zone, SystemTimeZoneIdentifier returns "America/New_York".

21.4.1.25 LocalTime ( t )

The abstract operation LocalTime takes argument t (a finite time value) and returns an integral Number. It converts t from UTC to local time. The local political rules for standard time and daylight saving time in effect at t should be used to determine the result in the way specified in this section. It performs the following steps when called:

  1. Let systemTimeZoneIdentifier be SystemTimeZoneIdentifier().
  2. If IsTimeZoneOffsetString(systemTimeZoneIdentifier) is true, then
    1. Let offsetNs be ParseTimeZoneOffsetString(systemTimeZoneIdentifier).
  3. Else,
    1. Let offsetNs be GetNamedTimeZoneOffsetNanoseconds(systemTimeZoneIdentifier, ((t) × 106)).
  4. Let offsetMs be truncate(offsetNs / 106).
  5. Return t + 𝔽(offsetMs).
Note 1

If political rules for the local time t are not available within the implementation, the result is t because SystemTimeZoneIdentifier returns "UTC" and GetNamedTimeZoneOffsetNanoseconds returns 0.

Note 2

It is required for time zone aware implementations (and recommended for all others) to use the time zone information of the IANA Time Zone Database https://www.iana.org/time-zones/.

Note 3

Two different input time values tUTC are converted to the same local time tlocal at a negative time zone transition when there are repeated times (e.g. the daylight saving time ends or the time zone adjustment is decreased.).

LocalTime(UTC(tlocal)) is not necessarily always equal to tlocal. Correspondingly, UTC(LocalTime(tUTC)) is not necessarily always equal to tUTC.

21.4.1.26 UTC ( t )

The abstract operation UTC takes argument t (a Number) and returns a time value. It converts t from local time to a UTC time value. The local political rules for standard time and daylight saving time in effect at t should be used to determine the result in the way specified in this section. It performs the following steps when called:

  1. If t is not finite, return NaN.
  2. Let systemTimeZoneIdentifier be SystemTimeZoneIdentifier().
  3. If IsTimeZoneOffsetString(systemTimeZoneIdentifier) is true, then
    1. Let offsetNs be ParseTimeZoneOffsetString(systemTimeZoneIdentifier).
  4. Else,
    1. Let possibleInstants be GetNamedTimeZoneEpochNanoseconds(systemTimeZoneIdentifier, (YearFromTime(t)), (MonthFromTime(t)) + 1, (DateFromTime(t)), (HourFromTime(t)), (MinFromTime(t)), (SecFromTime(t)), (msFromTime(t)), 0, 0).
    2. NOTE: The following steps ensure that when t represents local time repeating multiple times at a negative time zone transition (e.g. when the daylight saving time ends or the time zone offset is decreased due to a time zone rule change) or skipped local time at a positive time zone transition (e.g. when the daylight saving time starts or the time zone offset is increased due to a time zone rule change), t is interpreted using the time zone offset before the transition.
    3. If possibleInstants is not empty, then
      1. Let disambiguatedInstant be possibleInstants[0].
    4. Else,
      1. NOTE: t represents a local time skipped at a positive time zone transition (e.g. due to daylight saving time starting or a time zone rule change increasing the UTC offset).
      2. Let possibleInstantsBefore be GetNamedTimeZoneEpochNanoseconds(systemTimeZoneIdentifier, (YearFromTime(tBefore)), (MonthFromTime(tBefore)) + 1, (DateFromTime(tBefore)), (HourFromTime(tBefore)), (MinFromTime(tBefore)), (SecFromTime(tBefore)), (msFromTime(tBefore)), 0, 0), where tBefore is the largest integral Number < t for which possibleInstantsBefore is not empty (i.e., tBefore represents the last local time before the transition).
      3. Let disambiguatedInstant be the last element of possibleInstantsBefore.
    5. Let offsetNs be GetNamedTimeZoneOffsetNanoseconds(systemTimeZoneIdentifier, disambiguatedInstant).
  5. Let offsetMs be truncate(offsetNs / 106).
  6. Return t - 𝔽(offsetMs).

Input t is nominally a time value but may be any Number value. The algorithm must not limit t to the time value range, so that inputs corresponding with a boundary of the time value range can be supported regardless of local UTC offset. For example, the maximum time value is 8.64 × 1015, corresponding with "+275760-09-13T00:00:00Z". In an environment where the local time zone offset is ahead of UTC by 1 hour at that instant, it is represented by the larger input of 8.64 × 1015 + 3.6 × 106, corresponding with "+275760-09-13T01:00:00+01:00".

If political rules for the local time t are not available within the implementation, the result is t because SystemTimeZoneIdentifier returns "UTC" and GetNamedTimeZoneOffsetNanoseconds returns 0.

Note 1

It is required for time zone aware implementations (and recommended for all others) to use the time zone information of the IANA Time Zone Database https://www.iana.org/time-zones/.

1:30 AM on 5 November 2017 in America/New_York is repeated twice (fall backward), but it must be interpreted as 1:30 AM UTC-04 instead of 1:30 AM UTC-05. In UTC(TimeClip(MakeDate(MakeDay(2017, 10, 5), MakeTime(1, 30, 0, 0)))), the value of offsetMs is -4 × msPerHour.

2:30 AM on 12 March 2017 in America/New_York does not exist, but it must be interpreted as 2:30 AM UTC-05 (equivalent to 3:30 AM UTC-04). In UTC(TimeClip(MakeDate(MakeDay(2017, 2, 12), MakeTime(2, 30, 0, 0)))), the value of offsetMs is -5 × msPerHour.

Note 2

UTC(LocalTime(tUTC)) is not necessarily always equal to tUTC. Correspondingly, LocalTime(UTC(tlocal)) is not necessarily always equal to tlocal.

21.4.1.27 MakeTime ( hour, min, sec, ms )

The abstract operation MakeTime takes arguments hour (a Number), min (a Number), sec (a Number), and ms (a Number) and returns a Number. It calculates a number of milliseconds. It performs the following steps when called:

  1. If hour is not finite, min is not finite, sec is not finite, or ms is not finite, return NaN.
  2. Let h be 𝔽(! ToIntegerOrInfinity(hour)).
  3. Let m be 𝔽(! ToIntegerOrInfinity(min)).
  4. Let s be 𝔽(! ToIntegerOrInfinity(sec)).
  5. Let milli be 𝔽(! ToIntegerOrInfinity(ms)).
  6. Return ((h × msPerHour + m × msPerMinute) + s × msPerSecond) + milli.
Note

The arithmetic in MakeTime is floating-point arithmetic, which is not associative, so the operations must be performed in the correct order.

21.4.1.28 MakeDay ( year, month, date )

The abstract operation MakeDay takes arguments year (a Number), month (a Number), and date (a Number) and returns a Number. It calculates a number of days. It performs the following steps when called:

  1. If year is not finite, month is not finite, or date is not finite, return NaN.
  2. Let y be 𝔽(! ToIntegerOrInfinity(year)).
  3. Let m be 𝔽(! ToIntegerOrInfinity(month)).
  4. Let dt be 𝔽(! ToIntegerOrInfinity(date)).
  5. Let ym be y + 𝔽(floor((m) / 12)).
  6. If ym is not finite, return NaN.
  7. Let mn be 𝔽((m) modulo 12).
  8. Find a finite time value t such that YearFromTime(t) is ym, MonthFromTime(t) is mn, and DateFromTime(t) is 1𝔽; but if this is not possible (because some argument is out of range), return NaN.
  9. Return Day(t) + dt - 1𝔽.

21.4.1.29 MakeDate ( day, time )

The abstract operation MakeDate takes arguments day (a Number) and time (a Number) and returns a Number. It calculates a number of milliseconds. It performs the following steps when called:

  1. If day is not finite or time is not finite, return NaN.
  2. Let tv be day × msPerDay + time.
  3. If tv is not finite, return NaN.
  4. Return tv.

21.4.1.30 MakeFullYear ( year )

The abstract operation MakeFullYear takes argument year (a Number) and returns an integral Number or NaN. It returns the full year associated with the integer part of year, interpreting any value in the inclusive interval from 0 to 99 as a count of years since the start of 1900. For alignment with the proleptic Gregorian calendar, "full year" is defined as the signed count of complete years since the start of year 0 (1 B.C.). It performs the following steps when called:

  1. If year is NaN, return NaN.
  2. Let truncated be ! ToIntegerOrInfinity(year).
  3. If truncated is in the inclusive interval from 0 to 99, return 1900𝔽 + 𝔽(truncated).
  4. Return 𝔽(truncated).

21.4.1.31 TimeClip ( time )

The abstract operation TimeClip takes argument time (a Number) and returns a Number. It calculates a number of milliseconds. It performs the following steps when called:

  1. If time is not finite, return NaN.
  2. If abs((time)) > 8.64 × 1015, return NaN.
  3. Return 𝔽(! ToIntegerOrInfinity(time)).

21.4.1.32 Date Time String Format

ECMAScript defines a string interchange format for date-times based upon a simplification of the ISO 8601 calendar date extended format. The format is as follows: YYYY-MM-DDTHH:mm:ss.sssZ

Where the elements are as follows:

YYYY is the year in the proleptic Gregorian calendar as four decimal digits from 0000 to 9999, or as an expanded year of "+" or "-" followed by six decimal digits.
- "-" (hyphen) appears literally twice in the string.
MM is the month of the year as two decimal digits from 01 (January) to 12 (December).
DD is the day of the month as two decimal digits from 01 to 31.
T "T" appears literally in the string, to indicate the beginning of the time element.
HH is the number of complete hours that have passed since midnight as two decimal digits from 00 to 24.
: ":" (colon) appears literally twice in the string.
mm is the number of complete minutes since the start of the hour as two decimal digits from 00 to 59.
ss is the number of complete seconds since the start of the minute as two decimal digits from 00 to 59.
. "." (dot) appears literally in the string.
sss is the number of complete milliseconds since the start of the second as three decimal digits.
Z is the UTC offset representation specified as "Z" (for UTC with no offset) or as either "+" or "-" followed by a time expression HH:mm (a subset of the time zone offset string format for indicating local time ahead of or behind UTC, respectively)

This format includes date-only forms:

YYYY
YYYY-MM
YYYY-MM-DD
        

It also includes “date-time” forms that consist of one of the above date-only forms immediately followed by one of the following time forms with an optional UTC offset representation appended:

THH:mm
THH:mm:ss
THH:mm:ss.sss
        

A string containing out-of-bounds or nonconforming elements is not a valid instance of this format.

Note 1

As every day both starts and ends with midnight, the two notations 00:00 and 24:00 are available to distinguish the two midnights that can be associated with one date. This means that the following two notations refer to exactly the same point in time: 1995-02-04T24:00 and 1995-02-05T00:00. This interpretation of the latter form as "end of a calendar day" is consistent with ISO 8601, even though that specification reserves it for describing time intervals and does not permit it within representations of single points in time.

Note 2

There exists no international standard that specifies abbreviations for civil time zones like CET, EST, etc. and sometimes the same abbreviation is even used for two very different time zones. For this reason, both ISO 8601 and this format specify numeric representations of time zone offsets.

21.4.1.32.1 Expanded Years

Covering the full time value range of approximately 273,790 years forward or backward from 1 January 1970 (21.4.1.1) requires representing years before 0 or after 9999. ISO 8601 permits expansion of the year representation, but only by mutual agreement of the partners in information interchange. In the simplified ECMAScript format, such an expanded year representation shall have 6 digits and is always prefixed with a + or - sign. The year 0 is considered positive and must be prefixed with a + sign. The representation of the year 0 as -000000 is invalid. Strings matching the Date Time String Format with expanded years representing instants in time outside the range of a time value are treated as unrecognizable by Date.parse and cause that function to return NaN without falling back to implementation-specific behaviour or heuristics.

Note

Examples of date-time values with expanded years:

-271821-04-20T00:00:00Z 271822 B.C.
-000001-01-01T00:00:00Z 2 B.C.
+000000-01-01T00:00:00Z 1 B.C.
+000001-01-01T00:00:00Z 1 A.D.
+001970-01-01T00:00:00Z 1970 A.D.
+002009-12-15T00:00:00Z 2009 A.D.
+275760-09-13T00:00:00Z 275760 A.D.

21.4.1.33 Time Zone Offset String Format

ECMAScript defines a string interchange format for UTC offsets, derived from ISO 8601. The format is described by the following grammar.

Syntax

UTCOffset ::: ASCIISign Hour ASCIISign Hour HourSubcomponents[+Extended] ASCIISign Hour HourSubcomponents[~Extended] ASCIISign ::: one of + - Hour ::: 0 DecimalDigit 1 DecimalDigit 20 21 22 23 HourSubcomponents[Extended] ::: TimeSeparator[?Extended] MinuteSecond TimeSeparator[?Extended] MinuteSecond TimeSeparator[?Extended] MinuteSecond TemporalDecimalFractionopt TimeSeparator[Extended] ::: [+Extended] : [~Extended] [empty] MinuteSecond ::: 0 DecimalDigit 1 DecimalDigit 2 DecimalDigit 3 DecimalDigit 4 DecimalDigit 5 DecimalDigit TemporalDecimalFraction ::: TemporalDecimalSeparator DecimalDigit TemporalDecimalSeparator DecimalDigit DecimalDigit TemporalDecimalSeparator DecimalDigit DecimalDigit DecimalDigit TemporalDecimalSeparator DecimalDigit DecimalDigit DecimalDigit DecimalDigit TemporalDecimalSeparator DecimalDigit DecimalDigit DecimalDigit DecimalDigit DecimalDigit TemporalDecimalSeparator DecimalDigit DecimalDigit DecimalDigit DecimalDigit DecimalDigit DecimalDigit TemporalDecimalSeparator DecimalDigit DecimalDigit DecimalDigit DecimalDigit DecimalDigit DecimalDigit DecimalDigit TemporalDecimalSeparator DecimalDigit DecimalDigit DecimalDigit DecimalDigit DecimalDigit DecimalDigit DecimalDigit DecimalDigit TemporalDecimalSeparator DecimalDigit DecimalDigit DecimalDigit DecimalDigit DecimalDigit DecimalDigit DecimalDigit DecimalDigit DecimalDigit TemporalDecimalSeparator ::: one of . ,

21.4.1.33.1 IsTimeZoneOffsetString ( offsetString )

The abstract operation IsTimeZoneOffsetString takes argument offsetString (a String) and returns a Boolean. The return value indicates whether offsetString conforms to the grammar given by UTCOffset. It performs the following steps when called:

  1. Let parseResult be ParseText(offsetString, UTCOffset).
  2. If parseResult is a List of errors, return false.
  3. Return true.

21.4.1.33.2 ParseTimeZoneOffsetString ( offsetString )

The abstract operation ParseTimeZoneOffsetString takes argument offsetString (a String) and returns an integer. The return value is the UTC offset, as a number of nanoseconds, that corresponds to the String offsetString. It performs the following steps when called:

  1. Let parseResult be ParseText(offsetString, UTCOffset).
  2. Assert: parseResult is not a List of errors.
  3. Assert: parseResult contains a ASCIISign Parse Node.
  4. Let parsedSign be the source text matched by the ASCIISign Parse Node contained within parseResult.
  5. If parsedSign is the single code point U+002D (HYPHEN-MINUS), then
    1. Let sign be -1.
  6. Else,
    1. Let sign be 1.
  7. NOTE: Applications of StringToNumber below do not lose precision, since each of the parsed values is guaranteed to be a sufficiently short string of decimal digits.
  8. Assert: parseResult contains an Hour Parse Node.
  9. Let parsedHours be the source text matched by the Hour Parse Node contained within parseResult.
  10. Let hours be (StringToNumber(CodePointsToString(parsedHours))).
  11. If parseResult does not contain a MinuteSecond Parse Node, then
    1. Let minutes be 0.
  12. Else,
    1. Let parsedMinutes be the source text matched by the first MinuteSecond Parse Node contained within parseResult.
    2. Let minutes be (StringToNumber(CodePointsToString(parsedMinutes))).
  13. If parseResult does not contain two MinuteSecond Parse Nodes, then
    1. Let seconds be 0.
  14. Else,
    1. Let parsedSeconds be the source text matched by the second MinuteSecond Parse Node contained within parseResult.
    2. Let seconds be (StringToNumber(CodePointsToString(parsedSeconds))).
  15. If parseResult does not contain a TemporalDecimalFraction Parse Node, then
    1. Let nanoseconds be 0.
  16. Else,
    1. Let parsedFraction be the source text matched by the TemporalDecimalFraction Parse Node contained within parseResult.
    2. Let fraction be the string-concatenation of CodePointsToString(parsedFraction) and "000000000".
    3. Let nanosecondsString be the substring of fraction from 1 to 10.
    4. Let nanoseconds be (StringToNumber(nanosecondsString)).
  17. Return sign × (((hours × 60 + minutes) × 60 + seconds) × 109 + nanoseconds).

21.4.2 The Date Constructor

The Date constructor:

  • is %Date%.
  • is the initial value of the "Date" property of the global object.
  • creates and initializes a new Date when called as a constructor.
  • returns a String representing the current time (UTC) when called as a function rather than as a constructor.
  • is a function whose behaviour differs based upon the number and types of its arguments.
  • may be used as the value of an extends clause of a class definition. Subclass constructors that intend to inherit the specified Date behaviour must include a super call to the Date constructor to create and initialize the subclass instance with a [[DateValue]] internal slot.

21.4.2.1 Date ( ...values )

This function performs the following steps when called:

  1. If NewTarget is undefined, then
    1. Let now be the time value (UTC) identifying the current time.
    2. Return ToDateString(now).
  2. Let numberOfArgs be the number of elements in values.
  3. If numberOfArgs = 0, then
    1. Let dv be the time value (UTC) identifying the current time.
  4. Else if numberOfArgs = 1, then
    1. Let value be values[0].
    2. If value is an Object and value has a [[DateValue]] internal slot, then
      1. Let tv be value.[[DateValue]].
    3. Else,
      1. Let v be ? ToPrimitive(value).
      2. If v is a String, then
        1. Assert: The next step never returns an abrupt completion because v is a String.
        2. Let tv be the result of parsing v as a date, in exactly the same manner as for the parse method (21.4.3.2).
      3. Else,
        1. Let tv be ? ToNumber(v).
    4. Let dv be TimeClip(tv).
  5. Else,
    1. Assert: numberOfArgs ≥ 2.
    2. Let y be ? ToNumber(values[0]).
    3. Let m be ? ToNumber(values[1]).
    4. If numberOfArgs > 2, let dt be ? ToNumber(values[2]); else let dt be 1𝔽.
    5. If numberOfArgs > 3, let h be ? ToNumber(values[3]); else let h be +0𝔽.
    6. If numberOfArgs > 4, let min be ? ToNumber(values[4]); else let min be +0𝔽.
    7. If numberOfArgs > 5, let s be ? ToNumber(values[5]); else let s be +0𝔽.
    8. If numberOfArgs > 6, let milli be ? ToNumber(values[6]); else let milli be +0𝔽.
    9. Let yr be MakeFullYear(y).
    10. Let finalDate be MakeDate(MakeDay(yr, m, dt), MakeTime(h, min, s, milli)).
    11. Let dv be TimeClip(UTC(finalDate)).
  6. Let O be ? OrdinaryCreateFromConstructor(NewTarget, "%Date.prototype%", « [[DateValue]] »).
  7. Set O.[[DateValue]] to dv.
  8. Return O.

21.4.3 Properties of the Date Constructor

The Date constructor:

  • has a [[Prototype]] internal slot whose value is %Function.prototype%.
  • has a "length" property whose value is 7𝔽.
  • has the following properties:

21.4.3.1 Date.now ( )

This function returns the time value designating the UTC date and time of the occurrence of the call to it.

21.4.3.2 Date.parse ( string )

This function applies the ToString operator to its argument. If ToString results in an abrupt completion the Completion Record is immediately returned. Otherwise, this function interprets the resulting String as a date and time; it returns a Number, the UTC time value corresponding to the date and time. The String may be interpreted as a local time, a UTC time, or a time in some other time zone, depending on the contents of the String. The function first attempts to parse the String according to the format described in Date Time String Format (21.4.1.32), including expanded years. If the String does not conform to that format the function may fall back to any implementation-specific heuristics or implementation-specific date formats. Strings that are unrecognizable or contain out-of-bounds format element values shall cause this function to return NaN.

If the String conforms to the Date Time String Format, substitute values take the place of absent format elements. When the MM or DD elements are absent, "01" is used. When the HH, mm, or ss elements are absent, "00" is used. When the sss element is absent, "000" is used. When the UTC offset representation is absent, date-only forms are interpreted as a UTC time and date-time forms are interpreted as a local time.

If x is any Date whose milliseconds amount is zero within a particular implementation of ECMAScript, then all of the following expressions should produce the same numeric value in that implementation, if all the properties referenced have their initial values:

x.valueOf()
Date.parse(x.toString())
Date.parse(x.toUTCString())
Date.parse(x.toISOString())

However, the expression

Date.parse(x.toLocaleString())

is not required to produce the same Number value as the preceding three expressions and, in general, the value produced by this function is implementation-defined when given any String value that does not conform to the Date Time String Format (21.4.1.32) and that could not be produced in that implementation by the toString or toUTCString method.

21.4.3.3 Date.prototype

The initial value of Date.prototype is the Date prototype object.

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: false }.

21.4.3.4 Date.UTC ( year [ , month [ , date [ , hours [ , minutes [ , seconds [ , ms ] ] ] ] ] ] )

This function performs the following steps when called:

  1. Let y be ? ToNumber(year).
  2. If month is present, let m be ? ToNumber(month); else let m be +0𝔽.
  3. If date is present, let dt be ? ToNumber(date); else let dt be 1𝔽.
  4. If hours is present, let h be ? ToNumber(hours); else let h be +0𝔽.
  5. If minutes is present, let min be ? ToNumber(minutes); else let min be +0𝔽.
  6. If seconds is present, let s be ? ToNumber(seconds); else let s be +0𝔽.
  7. If ms is present, let milli be ? ToNumber(ms); else let milli be +0𝔽.
  8. Let yr be MakeFullYear(y).
  9. Return TimeClip(MakeDate(MakeDay(yr, m, dt), MakeTime(h, min, s, milli))).

The "length" property of this function is 7𝔽.

Note

This function differs from the Date constructor in two ways: it returns a time value as a Number, rather than creating a Date, and it interprets the arguments in UTC rather than as local time.

21.4.4 Properties of the Date Prototype Object

The Date prototype object:

  • is %Date.prototype%.
  • is itself an ordinary object.
  • is not a Date instance and does not have a [[DateValue]] internal slot.
  • has a [[Prototype]] internal slot whose value is %Object.prototype%.

Unless explicitly defined otherwise, the methods of the Date prototype object defined below are not generic and the this value passed to them must be an object that has a [[DateValue]] internal slot that has been initialized to a time value.

21.4.4.1 Date.prototype.constructor

The initial value of Date.prototype.constructor is %Date%.

21.4.4.2 Date.prototype.getDate ( )

This method performs the following steps when called:

  1. Let dateObject be the this value.
  2. Perform ? RequireInternalSlot(dateObject, [[DateValue]]).
  3. Let t be dateObject.[[DateValue]].
  4. If t is NaN, return NaN.
  5. Return DateFromTime(LocalTime(t)).

21.4.4.3 Date.prototype.getDay ( )

This method performs the following steps when called:

  1. Let dateObject be the this value.
  2. Perform ? RequireInternalSlot(dateObject, [[DateValue]]).
  3. Let t be dateObject.[[DateValue]].
  4. If t is NaN, return NaN.
  5. Return WeekDay(LocalTime(t)).

21.4.4.4 Date.prototype.getFullYear ( )

This method performs the following steps when called:

  1. Let dateObject be the this value.
  2. Perform ? RequireInternalSlot(dateObject, [[DateValue]]).
  3. Let t be dateObject.[[DateValue]].
  4. If t is NaN, return NaN.
  5. Return YearFromTime(LocalTime(t)).

21.4.4.5 Date.prototype.getHours ( )

This method performs the following steps when called:

  1. Let dateObject be the this value.
  2. Perform ? RequireInternalSlot(dateObject, [[DateValue]]).
  3. Let t be dateObject.[[DateValue]].
  4. If t is NaN, return NaN.
  5. Return HourFromTime(LocalTime(t)).

21.4.4.6 Date.prototype.getMilliseconds ( )

This method performs the following steps when called:

  1. Let dateObject be the this value.
  2. Perform ? RequireInternalSlot(dateObject, [[DateValue]]).
  3. Let t be dateObject.[[DateValue]].
  4. If t is NaN, return NaN.
  5. Return msFromTime(LocalTime(t)).

21.4.4.7 Date.prototype.getMinutes ( )

This method performs the following steps when called:

  1. Let dateObject be the this value.
  2. Perform ? RequireInternalSlot(dateObject, [[DateValue]]).
  3. Let t be dateObject.[[DateValue]].
  4. If t is NaN, return NaN.
  5. Return MinFromTime(LocalTime(t)).

21.4.4.8 Date.prototype.getMonth ( )

This method performs the following steps when called:

  1. Let dateObject be the this value.
  2. Perform ? RequireInternalSlot(dateObject, [[DateValue]]).
  3. Let t be dateObject.[[DateValue]].
  4. If t is NaN, return NaN.
  5. Return MonthFromTime(LocalTime(t)).

21.4.4.9 Date.prototype.getSeconds ( )

This method performs the following steps when called:

  1. Let dateObject be the this value.
  2. Perform ? RequireInternalSlot(dateObject, [[DateValue]]).
  3. Let t be dateObject.[[DateValue]].
  4. If t is NaN, return NaN.
  5. Return SecFromTime(LocalTime(t)).

21.4.4.10 Date.prototype.getTime ( )

This method performs the following steps when called:

  1. Let dateObject be the this value.
  2. Perform ? RequireInternalSlot(dateObject, [[DateValue]]).
  3. Return dateObject.[[DateValue]].

21.4.4.11 Date.prototype.getTimezoneOffset ( )

This method performs the following steps when called:

  1. Let dateObject be the this value.
  2. Perform ? RequireInternalSlot(dateObject, [[DateValue]]).
  3. Let t be dateObject.[[DateValue]].
  4. If t is NaN, return NaN.
  5. Return (t - LocalTime(t)) / msPerMinute.

21.4.4.12 Date.prototype.getUTCDate ( )

This method performs the following steps when called:

  1. Let dateObject be the this value.
  2. Perform ? RequireInternalSlot(dateObject, [[DateValue]]).
  3. Let t be dateObject.[[DateValue]].
  4. If t is NaN, return NaN.
  5. Return DateFromTime(t).

21.4.4.13 Date.prototype.getUTCDay ( )

This method performs the following steps when called:

  1. Let dateObject be the this value.
  2. Perform ? RequireInternalSlot(dateObject, [[DateValue]]).
  3. Let t be dateObject.[[DateValue]].
  4. If t is NaN, return NaN.
  5. Return WeekDay(t).

21.4.4.14 Date.prototype.getUTCFullYear ( )

This method performs the following steps when called:

  1. Let dateObject be the this value.
  2. Perform ? RequireInternalSlot(dateObject, [[DateValue]]).
  3. Let t be dateObject.[[DateValue]].
  4. If t is NaN, return NaN.
  5. Return YearFromTime(t).

21.4.4.15 Date.prototype.getUTCHours ( )

This method performs the following steps when called:

  1. Let dateObject be the this value.
  2. Perform ? RequireInternalSlot(dateObject, [[DateValue]]).
  3. Let t be dateObject.[[DateValue]].
  4. If t is NaN, return NaN.
  5. Return HourFromTime(t).

21.4.4.16 Date.prototype.getUTCMilliseconds ( )

This method performs the following steps when called:

  1. Let dateObject be the this value.
  2. Perform ? RequireInternalSlot(dateObject, [[DateValue]]).
  3. Let t be dateObject.[[DateValue]].
  4. If t is NaN, return NaN.
  5. Return msFromTime(t).

21.4.4.17 Date.prototype.getUTCMinutes ( )

This method performs the following steps when called:

  1. Let dateObject be the this value.
  2. Perform ? RequireInternalSlot(dateObject, [[DateValue]]).
  3. Let t be dateObject.[[DateValue]].
  4. If t is NaN, return NaN.
  5. Return MinFromTime(t).

21.4.4.18 Date.prototype.getUTCMonth ( )

This method performs the following steps when called:

  1. Let dateObject be the this value.
  2. Perform ? RequireInternalSlot(dateObject, [[DateValue]]).
  3. Let t be dateObject.[[DateValue]].
  4. If t is NaN, return NaN.
  5. Return MonthFromTime(t).

21.4.4.19 Date.prototype.getUTCSeconds ( )

This method performs the following steps when called:

  1. Let dateObject be the this value.
  2. Perform ? RequireInternalSlot(dateObject, [[DateValue]]).
  3. Let t be dateObject.[[DateValue]].
  4. If t is NaN, return NaN.
  5. Return SecFromTime(t).

21.4.4.20 Date.prototype.setDate ( date )

This method performs the following steps when called:

  1. Let dateObject be the this value.
  2. Perform ? RequireInternalSlot(dateObject, [[DateValue]]).
  3. Let t be dateObject.[[DateValue]].
  4. Let dt be ? ToNumber(date).
  5. If t is NaN, return NaN.
  6. Set t to LocalTime(t).
  7. Let newDate be MakeDate(MakeDay(YearFromTime(t), MonthFromTime(t), dt), TimeWithinDay(t)).
  8. Let u be TimeClip(UTC(newDate)).
  9. Set dateObject.[[DateValue]] to u.
  10. Return u.

21.4.4.21 Date.prototype.setFullYear ( year [ , month [ , date ] ] )

This method performs the following steps when called:

  1. Let dateObject be the this value.
  2. Perform ? RequireInternalSlot(dateObject, [[DateValue]]).
  3. Let t be dateObject.[[DateValue]].
  4. Let y be ? ToNumber(year).
  5. If t is NaN, set t to +0𝔽; otherwise set t to LocalTime(t).
  6. If month is not present, let m be MonthFromTime(t); otherwise let m be ? ToNumber(month).
  7. If date is not present, let dt be DateFromTime(t); otherwise let dt be ? ToNumber(date).
  8. Let newDate be MakeDate(MakeDay(y, m, dt), TimeWithinDay(t)).
  9. Let u be TimeClip(UTC(newDate)).
  10. Set dateObject.[[DateValue]] to u.
  11. Return u.

The "length" property of this method is 3𝔽.

Note

If month is not present, this method behaves as if month was present with the value getMonth(). If date is not present, it behaves as if date was present with the value getDate().

21.4.4.22 Date.prototype.setHours ( hour [ , min [ , sec [ , ms ] ] ] )

This method performs the following steps when called:

  1. Let dateObject be the this value.
  2. Perform ? RequireInternalSlot(dateObject, [[DateValue]]).
  3. Let t be dateObject.[[DateValue]].
  4. Let h be ? ToNumber(hour).
  5. If min is present, let m be ? ToNumber(min).
  6. If sec is present, let s be ? ToNumber(sec).
  7. If ms is present, let milli be ? ToNumber(ms).
  8. If t is NaN, return NaN.
  9. Set t to LocalTime(t).
  10. If min is not present, let m be MinFromTime(t).
  11. If sec is not present, let s be SecFromTime(t).
  12. If ms is not present, let milli be msFromTime(t).
  13. Let date be MakeDate(Day(t), MakeTime(h, m, s, milli)).
  14. Let u be TimeClip(UTC(date)).
  15. Set dateObject.[[DateValue]] to u.
  16. Return u.

The "length" property of this method is 4𝔽.

Note

If min is not present, this method behaves as if min was present with the value getMinutes(). If sec is not present, it behaves as if sec was present with the value getSeconds(). If ms is not present, it behaves as if ms was present with the value getMilliseconds().

21.4.4.23 Date.prototype.setMilliseconds ( ms )

This method performs the following steps when called:

  1. Let dateObject be the this value.
  2. Perform ? RequireInternalSlot(dateObject, [[DateValue]]).
  3. Let t be dateObject.[[DateValue]].
  4. Set ms to ? ToNumber(ms).
  5. If t is NaN, return NaN.
  6. Set t to LocalTime(t).
  7. Let time be MakeTime(HourFromTime(t), MinFromTime(t), SecFromTime(t), ms).
  8. Let u be TimeClip(UTC(MakeDate(Day(t), time))).
  9. Set dateObject.[[DateValue]] to u.
  10. Return u.

21.4.4.24 Date.prototype.setMinutes ( min [ , sec [ , ms ] ] )

This method performs the following steps when called:

  1. Let dateObject be the this value.
  2. Perform ? RequireInternalSlot(dateObject, [[DateValue]]).
  3. Let t be dateObject.[[DateValue]].
  4. Let m be ? ToNumber(min).
  5. If sec is present, let s be ? ToNumber(sec).
  6. If ms is present, let milli be ? ToNumber(ms).
  7. If t is NaN, return NaN.
  8. Set t to LocalTime(t).
  9. If sec is not present, let s be SecFromTime(t).
  10. If ms is not present, let milli be msFromTime(t).
  11. Let date be MakeDate(Day(t), MakeTime(HourFromTime(t), m, s, milli)).
  12. Let u be TimeClip(UTC(date)).
  13. Set dateObject.[[DateValue]] to u.
  14. Return u.

The "length" property of this method is 3𝔽.

Note

If sec is not present, this method behaves as if sec was present with the value getSeconds(). If ms is not present, this behaves as if ms was present with the value getMilliseconds().

21.4.4.25 Date.prototype.setMonth ( month [ , date ] )

This method performs the following steps when called:

  1. Let dateObject be the this value.
  2. Perform ? RequireInternalSlot(dateObject, [[DateValue]]).
  3. Let t be dateObject.[[DateValue]].
  4. Let m be ? ToNumber(month).
  5. If date is present, let dt be ? ToNumber(date).
  6. If t is NaN, return NaN.
  7. Set t to LocalTime(t).
  8. If date is not present, let dt be DateFromTime(t).
  9. Let newDate be MakeDate(MakeDay(YearFromTime(t), m, dt), TimeWithinDay(t)).
  10. Let u be TimeClip(UTC(newDate)).
  11. Set dateObject.[[DateValue]] to u.
  12. Return u.

The "length" property of this method is 2𝔽.

Note

If date is not present, this method behaves as if date was present with the value getDate().

21.4.4.26 Date.prototype.setSeconds ( sec [ , ms ] )

This method performs the following steps when called:

  1. Let dateObject be the this value.
  2. Perform ? RequireInternalSlot(dateObject, [[DateValue]]).
  3. Let t be dateObject.[[DateValue]].
  4. Let s be ? ToNumber(sec).
  5. If ms is present, let milli be ? ToNumber(ms).
  6. If t is NaN, return NaN.
  7. Set t to LocalTime(t).
  8. If ms is not present, let milli be msFromTime(t).
  9. Let date be MakeDate(Day(t), MakeTime(HourFromTime(t), MinFromTime(t), s, milli)).
  10. Let u be TimeClip(UTC(date)).
  11. Set dateObject.[[DateValue]] to u.
  12. Return u.

The "length" property of this method is 2𝔽.

Note

If ms is not present, this method behaves as if ms was present with the value getMilliseconds().

21.4.4.27 Date.prototype.setTime ( time )

This method performs the following steps when called:

  1. Let dateObject be the this value.
  2. Perform ? RequireInternalSlot(dateObject, [[DateValue]]).
  3. Let t be ? ToNumber(time).
  4. Let v be TimeClip(t).
  5. Set dateObject.[[DateValue]] to v.
  6. Return v.

21.4.4.28 Date.prototype.setUTCDate ( date )

This method performs the following steps when called:

  1. Let dateObject be the this value.
  2. Perform ? RequireInternalSlot(dateObject, [[DateValue]]).
  3. Let t be dateObject.[[DateValue]].
  4. Let dt be ? ToNumber(date).
  5. If t is NaN, return NaN.
  6. Let newDate be MakeDate(MakeDay(YearFromTime(t), MonthFromTime(t), dt), TimeWithinDay(t)).
  7. Let v be TimeClip(newDate).
  8. Set dateObject.[[DateValue]] to v.
  9. Return v.

21.4.4.29 Date.prototype.setUTCFullYear ( year [ , month [ , date ] ] )

This method performs the following steps when called:

  1. Let dateObject be the this value.
  2. Perform ? RequireInternalSlot(dateObject, [[DateValue]]).
  3. Let t be dateObject.[[DateValue]].
  4. If t is NaN, set t to +0𝔽.
  5. Let y be ? ToNumber(year).
  6. If month is not present, let m be MonthFromTime(t); otherwise let m be ? ToNumber(month).
  7. If date is not present, let dt be DateFromTime(t); otherwise let dt be ? ToNumber(date).
  8. Let newDate be MakeDate(MakeDay(y, m, dt), TimeWithinDay(t)).
  9. Let v be TimeClip(newDate).
  10. Set dateObject.[[DateValue]] to v.
  11. Return v.

The "length" property of this method is 3𝔽.

Note

If month is not present, this method behaves as if month was present with the value getUTCMonth(). If date is not present, it behaves as if date was present with the value getUTCDate().

21.4.4.30 Date.prototype.setUTCHours ( hour [ , min [ , sec [ , ms ] ] ] )

This method performs the following steps when called:

  1. Let dateObject be the this value.
  2. Perform ? RequireInternalSlot(dateObject, [[DateValue]]).
  3. Let t be dateObject.[[DateValue]].
  4. Let h be ? ToNumber(hour).
  5. If min is present, let m be ? ToNumber(min).
  6. If sec is present, let s be ? ToNumber(sec).
  7. If ms is present, let milli be ? ToNumber(ms).
  8. If t is NaN, return NaN.
  9. If min is not present, let m be MinFromTime(t).
  10. If sec is not present, let s be SecFromTime(t).
  11. If ms is not present, let milli be msFromTime(t).
  12. Let date be MakeDate(Day(t), MakeTime(h, m, s, milli)).
  13. Let v be TimeClip(date).
  14. Set dateObject.[[DateValue]] to v.
  15. Return v.

The "length" property of this method is 4𝔽.

Note

If min is not present, this method behaves as if min was present with the value getUTCMinutes(). If sec is not present, it behaves as if sec was present with the value getUTCSeconds(). If ms is not present, it behaves as if ms was present with the value getUTCMilliseconds().

21.4.4.31 Date.prototype.setUTCMilliseconds ( ms )

This method performs the following steps when called:

  1. Let dateObject be the this value.
  2. Perform ? RequireInternalSlot(dateObject, [[DateValue]]).
  3. Let t be dateObject.[[DateValue]].
  4. Set ms to ? ToNumber(ms).
  5. If t is NaN, return NaN.
  6. Let time be MakeTime(HourFromTime(t), MinFromTime(t), SecFromTime(t), ms).
  7. Let v be TimeClip(MakeDate(Day(t), time)).
  8. Set dateObject.[[DateValue]] to v.
  9. Return v.

21.4.4.32 Date.prototype.setUTCMinutes ( min [ , sec [ , ms ] ] )

This method performs the following steps when called:

  1. Let dateObject be the this value.
  2. Perform ? RequireInternalSlot(dateObject, [[DateValue]]).
  3. Let t be dateObject.[[DateValue]].
  4. Let m be ? ToNumber(min).
  5. If sec is present, let s be ? ToNumber(sec).
  6. If ms is present, let milli be ? ToNumber(ms).
  7. If t is NaN, return NaN.
  8. If sec is not present, let s be SecFromTime(t).
  9. If ms is not present, let milli be msFromTime(t).
  10. Let date be MakeDate(Day(t), MakeTime(HourFromTime(t), m, s, milli)).
  11. Let v be TimeClip(date).
  12. Set dateObject.[[DateValue]] to v.
  13. Return v.

The "length" property of this method is 3𝔽.

Note

If sec is not present, this method behaves as if sec was present with the value getUTCSeconds(). If ms is not present, it behaves as if ms was present with the value return by getUTCMilliseconds().

21.4.4.33 Date.prototype.setUTCMonth ( month [ , date ] )

This method performs the following steps when called:

  1. Let dateObject be the this value.
  2. Perform ? RequireInternalSlot(dateObject, [[DateValue]]).
  3. Let t be dateObject.[[DateValue]].
  4. Let m be ? ToNumber(month).
  5. If date is present, let dt be ? ToNumber(date).
  6. If t is NaN, return NaN.
  7. If date is not present, let dt be DateFromTime(t).
  8. Let newDate be MakeDate(MakeDay(YearFromTime(t), m, dt), TimeWithinDay(t)).
  9. Let v be TimeClip(newDate).
  10. Set dateObject.[[DateValue]] to v.
  11. Return v.

The "length" property of this method is 2𝔽.

Note

If date is not present, this method behaves as if date was present with the value getUTCDate().

21.4.4.34 Date.prototype.setUTCSeconds ( sec [ , ms ] )

This method performs the following steps when called:

  1. Let dateObject be the this value.
  2. Perform ? RequireInternalSlot(dateObject, [[DateValue]]).
  3. Let t be dateObject.[[DateValue]].
  4. Let s be ? ToNumber(sec).
  5. If ms is present, let milli be ? ToNumber(ms).
  6. If t is NaN, return NaN.
  7. If ms is not present, let milli be msFromTime(t).
  8. Let date be MakeDate(Day(t), MakeTime(HourFromTime(t), MinFromTime(t), s, milli)).
  9. Let v be TimeClip(date).
  10. Set dateObject.[[DateValue]] to v.
  11. Return v.

The "length" property of this method is 2𝔽.

Note

If ms is not present, this method behaves as if ms was present with the value getUTCMilliseconds().

21.4.4.35 Date.prototype.toDateString ( )

This method performs the following steps when called:

  1. Let dateObject be the this value.
  2. Perform ? RequireInternalSlot(dateObject, [[DateValue]]).
  3. Let tv be dateObject.[[DateValue]].
  4. If tv is NaN, return "Invalid Date".
  5. Let t be LocalTime(tv).
  6. Return DateString(t).

21.4.4.36 Date.prototype.toISOString ( )

This method performs the following steps when called:

  1. Let dateObject be the this value.
  2. Perform ? RequireInternalSlot(dateObject, [[DateValue]]).
  3. Let tv be dateObject.[[DateValue]].
  4. If tv is NaN, throw a RangeError exception.
  5. Assert: tv is an integral Number.
  6. If tv corresponds with a year that cannot be represented in the Date Time String Format, throw a RangeError exception.
  7. Return a String representation of tv in the Date Time String Format on the UTC time scale, including all format elements and the UTC offset representation "Z".

21.4.4.37 Date.prototype.toJSON ( key )

This method provides a String representation of a Date for use by JSON.stringify (25.5.2).

It performs the following steps when called:

  1. Let O be ? ToObject(this value).
  2. Let tv be ? ToPrimitive(O, number).
  3. If tv is a Number and tv is not finite, return null.
  4. Return ? Invoke(O, "toISOString").
Note 1

The argument is ignored.

Note 2

This method is intentionally generic; it does not require that its this value be a Date. Therefore, it can be transferred to other kinds of objects for use as a method. However, it does require that any such object have a toISOString method.

21.4.4.38 Date.prototype.toLocaleDateString ( [ reserved1 [ , reserved2 ] ] )

An ECMAScript implementation that includes the ECMA-402 Internationalization API must implement this method as specified in the ECMA-402 specification. If an ECMAScript implementation does not include the ECMA-402 API the following specification of this method is used:

This method returns a String value. The contents of the String are implementation-defined, but are intended to represent the “date” portion of the Date in the current time zone in a convenient, human-readable form that corresponds to the conventions of the host environment's current locale.

The meaning of the optional parameters to this method are defined in the ECMA-402 specification; implementations that do not include ECMA-402 support must not use those parameter positions for anything else.

21.4.4.39 Date.prototype.toLocaleString ( [ reserved1 [ , reserved2 ] ] )

An ECMAScript implementation that includes the ECMA-402 Internationalization API must implement this method as specified in the ECMA-402 specification. If an ECMAScript implementation does not include the ECMA-402 API the following specification of this method is used:

This method returns a String value. The contents of the String are implementation-defined, but are intended to represent the Date in the current time zone in a convenient, human-readable form that corresponds to the conventions of the host environment's current locale.

The meaning of the optional parameters to this method are defined in the ECMA-402 specification; implementations that do not include ECMA-402 support must not use those parameter positions for anything else.

21.4.4.40 Date.prototype.toLocaleTimeString ( [ reserved1 [ , reserved2 ] ] )

An ECMAScript implementation that includes the ECMA-402 Internationalization API must implement this method as specified in the ECMA-402 specification. If an ECMAScript implementation does not include the ECMA-402 API the following specification of this method is used:

This method returns a String value. The contents of the String are implementation-defined, but are intended to represent the “time” portion of the Date in the current time zone in a convenient, human-readable form that corresponds to the conventions of the host environment's current locale.

The meaning of the optional parameters to this method are defined in the ECMA-402 specification; implementations that do not include ECMA-402 support must not use those parameter positions for anything else.

21.4.4.41 Date.prototype.toString ( )

This method performs the following steps when called:

  1. Let dateObject be the this value.
  2. Perform ? RequireInternalSlot(dateObject, [[DateValue]]).
  3. Let tv be dateObject.[[DateValue]].
  4. Return ToDateString(tv).
Note 1

For any Date d such that d.[[DateValue]] is evenly divisible by 1000, the result of Date.parse(d.toString()) = d.valueOf(). See 21.4.3.2.

Note 2

This method is not generic; it throws a TypeError exception if its this value is not a Date. Therefore, it cannot be transferred to other kinds of objects for use as a method.

21.4.4.41.1 TimeString ( tv )

The abstract operation TimeString takes argument tv (a Number, but not NaN) and returns a String. It performs the following steps when called:

  1. Let hour be ToZeroPaddedDecimalString((HourFromTime(tv)), 2).
  2. Let minute be ToZeroPaddedDecimalString((MinFromTime(tv)), 2).
  3. Let second be ToZeroPaddedDecimalString((SecFromTime(tv)), 2).
  4. Return the string-concatenation of hour, ":", minute, ":", second, the code unit 0x0020 (SPACE), and "GMT".

21.4.4.41.2 DateString ( tv )

The abstract operation DateString takes argument tv (a Number, but not NaN) and returns a String. It performs the following steps when called:

  1. Let weekday be the Name of the entry in Table 65 with the Number WeekDay(tv).
  2. Let month be the Name of the entry in Table 66 with the Number MonthFromTime(tv).
  3. Let day be ToZeroPaddedDecimalString((DateFromTime(tv)), 2).
  4. Let yv be YearFromTime(tv).
  5. If yv is +0𝔽 or yv > +0𝔽, let yearSign be the empty String; otherwise let yearSign be "-".
  6. Let paddedYear be ToZeroPaddedDecimalString(abs((yv)), 4).
  7. Return the string-concatenation of weekday, the code unit 0x0020 (SPACE), month, the code unit 0x0020 (SPACE), day, the code unit 0x0020 (SPACE), yearSign, and paddedYear.
Table 65: Names of days of the week
Number Name
+0𝔽 "Sun"
1𝔽 "Mon"
2𝔽 "Tue"
3𝔽 "Wed"
4𝔽 "Thu"
5𝔽 "Fri"
6𝔽 "Sat"
Table 66: Names of months of the year
Number Name
+0𝔽 "Jan"
1𝔽 "Feb"
2𝔽 "Mar"
3𝔽 "Apr"
4𝔽 "May"
5𝔽 "Jun"
6𝔽 "Jul"
7𝔽 "Aug"
8𝔽 "Sep"
9𝔽 "Oct"
10𝔽 "Nov"
11𝔽 "Dec"

21.4.4.41.3 TimeZoneString ( tv )

The abstract operation TimeZoneString takes argument tv (an integral Number) and returns a String. It performs the following steps when called:

  1. Let systemTimeZoneIdentifier be SystemTimeZoneIdentifier().
  2. If IsTimeZoneOffsetString(systemTimeZoneIdentifier) is true, then
    1. Let offsetNs be ParseTimeZoneOffsetString(systemTimeZoneIdentifier).
  3. Else,
    1. Let offsetNs be GetNamedTimeZoneOffsetNanoseconds(systemTimeZoneIdentifier, ((tv) × 106)).
  4. Let offset be 𝔽(truncate(offsetNs / 106)).
  5. If offset is +0𝔽 or offset > +0𝔽, then
    1. Let offsetSign be "+".
    2. Let absOffset be offset.
  6. Else,
    1. Let offsetSign be "-".
    2. Let absOffset be -offset.
  7. Let offsetMin be ToZeroPaddedDecimalString((MinFromTime(absOffset)), 2).
  8. Let offsetHour be ToZeroPaddedDecimalString((HourFromTime(absOffset)), 2).
  9. Let tzName be an implementation-defined string that is either the empty String or the string-concatenation of the code unit 0x0020 (SPACE), the code unit 0x0028 (LEFT PARENTHESIS), an implementation-defined timezone name, and the code unit 0x0029 (RIGHT PARENTHESIS).
  10. Return the string-concatenation of offsetSign, offsetHour, offsetMin, and tzName.

21.4.4.41.4 ToDateString ( tv )

The abstract operation ToDateString takes argument tv (an integral Number or NaN) and returns a String. It performs the following steps when called:

  1. If tv is NaN, return "Invalid Date".
  2. Let t be LocalTime(tv).
  3. Return the string-concatenation of DateString(t), the code unit 0x0020 (SPACE), TimeString(t), and TimeZoneString(tv).

21.4.4.42 Date.prototype.toTimeString ( )

This method performs the following steps when called:

  1. Let dateObject be the this value.
  2. Perform ? RequireInternalSlot(dateObject, [[DateValue]]).
  3. Let tv be dateObject.[[DateValue]].
  4. If tv is NaN, return "Invalid Date".
  5. Let t be LocalTime(tv).
  6. Return the string-concatenation of TimeString(t) and TimeZoneString(tv).

21.4.4.43 Date.prototype.toUTCString ( )

This method returns a String value representing the instant in time corresponding to the this value. The format of the String is based upon "HTTP-date" from RFC 7231, generalized to support the full range of times supported by ECMAScript Dates.

It performs the following steps when called:

  1. Let dateObject be the this value.
  2. Perform ? RequireInternalSlot(dateObject, [[DateValue]]).
  3. Let tv be dateObject.[[DateValue]].
  4. If tv is NaN, return "Invalid Date".
  5. Let weekday be the Name of the entry in Table 65 with the Number WeekDay(tv).
  6. Let month be the Name of the entry in Table 66 with the Number MonthFromTime(tv).
  7. Let day be ToZeroPaddedDecimalString((DateFromTime(tv)), 2).
  8. Let yv be YearFromTime(tv).
  9. If yv is +0𝔽 or yv > +0𝔽, let yearSign be the empty String; otherwise let yearSign be "-".
  10. Let paddedYear be ToZeroPaddedDecimalString(abs((yv)), 4).
  11. Return the string-concatenation of weekday, ",", the code unit 0x0020 (SPACE), day, the code unit 0x0020 (SPACE), month, the code unit 0x0020 (SPACE), yearSign, paddedYear, the code unit 0x0020 (SPACE), and TimeString(tv).

21.4.4.44 Date.prototype.valueOf ( )

This method performs the following steps when called:

  1. Let dateObject be the this value.
  2. Perform ? RequireInternalSlot(dateObject, [[DateValue]]).
  3. Return dateObject.[[DateValue]].

21.4.4.45 Date.prototype [ %Symbol.toPrimitive% ] ( hint )

This method is called by ECMAScript language operators to convert a Date to a primitive value. The allowed values for hint are "default", "number", and "string". Dates are unique among built-in ECMAScript object in that they treat "default" as being equivalent to "string", All other built-in ECMAScript objects treat "default" as being equivalent to "number".

It performs the following steps when called:

  1. Let O be the this value.
  2. If O is not an Object, throw a TypeError exception.
  3. If hint is either "string" or "default", then
    1. Let tryFirst be string.
  4. Else if hint is "number", then
    1. Let tryFirst be number.
  5. Else,
    1. Throw a TypeError exception.
  6. Return ? OrdinaryToPrimitive(O, tryFirst).

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: true }.

The value of the "name" property of this method is "[Symbol.toPrimitive]".

21.4.5 Properties of Date Instances

Date instances are ordinary objects that inherit properties from the Date prototype object. Date instances also have a [[DateValue]] internal slot. The [[DateValue]] internal slot is the time value represented by this Date.

22 Text Processing

22.1 String Objects

22.1.1 The String Constructor

The String constructor:

  • is %String%.
  • is the initial value of the "String" property of the global object.
  • creates and initializes a new String object when called as a constructor.
  • performs a type conversion when called as a function rather than as a constructor.
  • may be used as the value of an extends clause of a class definition. Subclass constructors that intend to inherit the specified String behaviour must include a super call to the String constructor to create and initialize the subclass instance with a [[StringData]] internal slot.

22.1.1.1 String ( value )

This function performs the following steps when called:

  1. If value is not present, then
    1. Let s be the empty String.
  2. Else,
    1. If NewTarget is undefined and value is a Symbol, return SymbolDescriptiveString(value).
    2. Let s be ? ToString(value).
  3. If NewTarget is undefined, return s.
  4. Return StringCreate(s, ? GetPrototypeFromConstructor(NewTarget, "%String.prototype%")).

22.1.2 Properties of the String Constructor

The String constructor:

  • has a [[Prototype]] internal slot whose value is %Function.prototype%.
  • has the following properties:

22.1.2.1 String.fromCharCode ( ...codeUnits )

This function may be called with any number of arguments which form the rest parameter codeUnits.

It performs the following steps when called:

  1. Let result be the empty String.
  2. For each element next of codeUnits, do
    1. Let nextCU be the code unit whose numeric value is (? ToUint16(next)).
    2. Set result to the string-concatenation of result and nextCU.
  3. Return result.

The "length" property of this function is 1𝔽.

22.1.2.2 String.fromCodePoint ( ...codePoints )

This function may be called with any number of arguments which form the rest parameter codePoints.

It performs the following steps when called:

  1. Let result be the empty String.
  2. For each element next of codePoints, do
    1. Let nextCP be ? ToNumber(next).
    2. If nextCP is not an integral Number, throw a RangeError exception.
    3. If (nextCP) < 0 or (nextCP) > 0x10FFFF, throw a RangeError exception.
    4. Set result to the string-concatenation of result and UTF16EncodeCodePoint((nextCP)).
  3. Assert: If codePoints is empty, then result is the empty String.
  4. Return result.

The "length" property of this function is 1𝔽.

22.1.2.3 String.prototype

The initial value of String.prototype is the String prototype object.

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: false }.

22.1.2.4 String.raw ( template, ...substitutions )

This function may be called with a variable number of arguments. The first argument is template and the remainder of the arguments form the List substitutions.

It performs the following steps when called:

  1. Let substitutionCount be the number of elements in substitutions.
  2. Let cooked be ? ToObject(template).
  3. Let literals be ? ToObject(? Get(cooked, "raw")).
  4. Let literalCount be ? LengthOfArrayLike(literals).
  5. If literalCount ≤ 0, return the empty String.
  6. Let R be the empty String.
  7. Let nextIndex be 0.
  8. Repeat,
    1. Let nextLiteralVal be ? Get(literals, ! ToString(𝔽(nextIndex))).
    2. Let nextLiteral be ? ToString(nextLiteralVal).
    3. Set R to the string-concatenation of R and nextLiteral.
    4. If nextIndex + 1 = literalCount, return R.
    5. If nextIndex < substitutionCount, then
      1. Let nextSubVal be substitutions[nextIndex].
      2. Let nextSub be ? ToString(nextSubVal).
      3. Set R to the string-concatenation of R and nextSub.
    6. Set nextIndex to nextIndex + 1.
Note

This function is intended for use as a tag function of a Tagged Template (13.3.11). When called as such, the first argument will be a well formed template object and the rest parameter will contain the substitution values.

22.1.3 Properties of the String Prototype Object

The String prototype object:

  • is %String.prototype%.
  • is a String exotic object and has the internal methods specified for such objects.
  • has a [[StringData]] internal slot whose value is the empty String.
  • has a "length" property whose initial value is +0𝔽 and whose attributes are { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: false }.
  • has a [[Prototype]] internal slot whose value is %Object.prototype%.

Unless explicitly stated otherwise, the methods of the String prototype object defined below are not generic and the this value passed to them must be either a String value or an object that has a [[StringData]] internal slot that has been initialized to a String value.

22.1.3.1 String.prototype.at ( index )

  1. Let O be ? RequireObjectCoercible(this value).
  2. Let S be ? ToString(O).
  3. Let len be the length of S.
  4. Let relativeIndex be ? ToIntegerOrInfinity(index).
  5. If relativeIndex ≥ 0, then
    1. Let k be relativeIndex.
  6. Else,
    1. Let k be len + relativeIndex.
  7. If k < 0 or klen, return undefined.
  8. Return the substring of S from k to k + 1.

22.1.3.2 String.prototype.charAt ( pos )

Note 1

This method returns a single element String containing the code unit at index pos within the String value resulting from converting this object to a String. If there is no element at that index, the result is the empty String. The result is a String value, not a String object.

If pos is an integral Number, then the result of x.charAt(pos) is equivalent to the result of x.substring(pos, pos + 1).

This method performs the following steps when called:

  1. Let O be ? RequireObjectCoercible(this value).
  2. Let S be ? ToString(O).
  3. Let position be ? ToIntegerOrInfinity(pos).
  4. Let size be the length of S.
  5. If position < 0 or positionsize, return the empty String.
  6. Return the substring of S from position to position + 1.
Note 2

This method is intentionally generic; it does not require that its this value be a String object. Therefore, it can be transferred to other kinds of objects for use as a method.

22.1.3.3 String.prototype.charCodeAt ( pos )

Note 1

This method returns a Number (a non-negative integral Number less than 216) that is the numeric value of the code unit at index pos within the String resulting from converting this object to a String. If there is no element at that index, the result is NaN.

This method performs the following steps when called:

  1. Let O be ? RequireObjectCoercible(this value).
  2. Let S be ? ToString(O).
  3. Let position be ? ToIntegerOrInfinity(pos).
  4. Let size be the length of S.
  5. If position < 0 or positionsize, return NaN.
  6. Return the Number value for the numeric value of the code unit at index position within the String S.
Note 2

This method is intentionally generic; it does not require that its this value be a String object. Therefore it can be transferred to other kinds of objects for use as a method.

22.1.3.4 String.prototype.codePointAt ( pos )

Note 1

This method returns a non-negative integral Number less than or equal to 0x10FFFF𝔽 that is the numeric value of the UTF-16 encoded code point (6.1.4) starting at the string element at index pos within the String resulting from converting this object to a String. If there is no element at that index, the result is undefined. If a valid UTF-16 surrogate pair does not begin at pos, the result is the code unit at pos.

This method performs the following steps when called:

  1. Let O be ? RequireObjectCoercible(this value).
  2. Let S be ? ToString(O).
  3. Let position be ? ToIntegerOrInfinity(pos).
  4. Let size be the length of S.
  5. If position < 0 or positionsize, return undefined.
  6. Let cp be CodePointAt(S, position).
  7. Return 𝔽(cp.[[CodePoint]]).
Note 2

This method is intentionally generic; it does not require that its this value be a String object. Therefore it can be transferred to other kinds of objects for use as a method.

22.1.3.5 String.prototype.concat ( ...args )

Note 1

When this method is called it returns the String value consisting of the code units of the this value (converted to a String) followed by the code units of each of the arguments converted to a String. The result is a String value, not a String object.

This method performs the following steps when called:

  1. Let O be ? RequireObjectCoercible(this value).
  2. Let S be ? ToString(O).
  3. Let R be S.
  4. For each element next of args, do
    1. Let nextString be ? ToString(next).
    2. Set R to the string-concatenation of R and nextString.
  5. Return R.

The "length" property of this method is 1𝔽.

Note 2

This method is intentionally generic; it does not require that its this value be a String object. Therefore it can be transferred to other kinds of objects for use as a method.

22.1.3.6 String.prototype.constructor

The initial value of String.prototype.constructor is %String%.

22.1.3.7 String.prototype.endsWith ( searchString [ , endPosition ] )

This method performs the following steps when called:

  1. Let O be ? RequireObjectCoercible(this value).
  2. Let S be ? ToString(O).
  3. Let isRegExp be ? IsRegExp(searchString).
  4. If isRegExp is true, throw a TypeError exception.
  5. Let searchStr be ? ToString(searchString).
  6. Let len be the length of S.
  7. If endPosition is undefined, let pos be len; else let pos be ? ToIntegerOrInfinity(endPosition).
  8. Let end be the result of clamping pos between 0 and len.
  9. Let searchLength be the length of searchStr.
  10. If searchLength = 0, return true.
  11. Let start be end - searchLength.
  12. If start < 0, return false.
  13. Let substring be the substring of S from start to end.
  14. If substring is searchStr, return true.
  15. Return false.
Note 1

This method returns true if the sequence of code units of searchString converted to a String is the same as the corresponding code units of this object (converted to a String) starting at endPosition - length(this). Otherwise it returns false.

Note 2

Throwing an exception if the first argument is a RegExp is specified in order to allow future editions to define extensions that allow such argument values.

Note 3

This method is intentionally generic; it does not require that its this value be a String object. Therefore, it can be transferred to other kinds of objects for use as a method.

22.1.3.8 String.prototype.includes ( searchString [ , position ] )

This method performs the following steps when called:

  1. Let O be ? RequireObjectCoercible(this value).
  2. Let S be ? ToString(O).
  3. Let isRegExp be ? IsRegExp(searchString).
  4. If isRegExp is true, throw a TypeError exception.
  5. Let searchStr be ? ToString(searchString).
  6. Let pos be ? ToIntegerOrInfinity(position).
  7. Assert: If position is undefined, then pos is 0.
  8. Let len be the length of S.
  9. Let start be the result of clamping pos between 0 and len.
  10. Let index be StringIndexOf(S, searchStr, start).
  11. If index is not-found, return false.
  12. Return true.
Note 1

If searchString appears as a substring of the result of converting this object to a String, at one or more indices that are greater than or equal to position, this function returns true; otherwise, it returns false. If position is undefined, 0 is assumed, so as to search all of the String.

Note 2

Throwing an exception if the first argument is a RegExp is specified in order to allow future editions to define extensions that allow such argument values.

Note 3

This method is intentionally generic; it does not require that its this value be a String object. Therefore, it can be transferred to other kinds of objects for use as a method.

22.1.3.9 String.prototype.indexOf ( searchString [ , position ] )

Note 1

If searchString appears as a substring of the result of converting this object to a String, at one or more indices that are greater than or equal to position, then the smallest such index is returned; otherwise, -1𝔽 is returned. If position is undefined, +0𝔽 is assumed, so as to search all of the String.

This method performs the following steps when called:

  1. Let O be ? RequireObjectCoercible(this value).
  2. Let S be ? ToString(O).
  3. Let searchStr be ? ToString(searchString).
  4. Let pos be ? ToIntegerOrInfinity(position).
  5. Assert: If position is undefined, then pos is 0.
  6. Let len be the length of S.
  7. Let start be the result of clamping pos between 0 and len.
  8. Let result be StringIndexOf(S, searchStr, start).
  9. If result is not-found, return -1𝔽.
  10. Return 𝔽(result).
Note 2

This method is intentionally generic; it does not require that its this value be a String object. Therefore, it can be transferred to other kinds of objects for use as a method.

22.1.3.10 String.prototype.isWellFormed ( )

This method performs the following steps when called:

  1. Let O be ? RequireObjectCoercible(this value).
  2. Let S be ? ToString(O).
  3. Return IsStringWellFormedUnicode(S).

22.1.3.11 String.prototype.lastIndexOf ( searchString [ , position ] )

Note 1

If searchString appears as a substring of the result of converting this object to a String at one or more indices that are smaller than or equal to position, then the greatest such index is returned; otherwise, -1𝔽 is returned. If position is undefined, the length of the String value is assumed, so as to search all of the String.

This method performs the following steps when called:

  1. Let O be ? RequireObjectCoercible(this value).
  2. Let S be ? ToString(O).
  3. Let searchStr be ? ToString(searchString).
  4. Let numPos be ? ToNumber(position).
  5. Assert: If position is undefined, then numPos is NaN.
  6. If numPos is NaN, let pos be +∞; otherwise let pos be ! ToIntegerOrInfinity(numPos).
  7. Let len be the length of S.
  8. Let searchLen be the length of searchStr.
  9. Let start be the result of clamping pos between 0 and len - searchLen.
  10. Let result be StringLastIndexOf(S, searchStr, start).
  11. If result is not-found, return -1𝔽.
  12. Return 𝔽(result).
Note 2

This method is intentionally generic; it does not require that its this value be a String object. Therefore, it can be transferred to other kinds of objects for use as a method.

22.1.3.12 String.prototype.localeCompare ( that [ , reserved1 [ , reserved2 ] ] )

An ECMAScript implementation that includes the ECMA-402 Internationalization API must implement this method as specified in the ECMA-402 specification. If an ECMAScript implementation does not include the ECMA-402 API the following specification of this method is used:

This method returns a Number other than NaN representing the result of an implementation-defined locale-sensitive String comparison of the this value (converted to a String S) with that (converted to a String thatValue). The result is intended to correspond with a sort order of String values according to conventions of the host environment's current locale, and will be negative when S is ordered before thatValue, positive when S is ordered after thatValue, and zero in all other cases (representing no relative ordering between S and thatValue).

Before performing the comparisons, this method performs the following steps to prepare the Strings:

  1. Let O be ? RequireObjectCoercible(this value).
  2. Let S be ? ToString(O).
  3. Let thatValue be ? ToString(that).

The meaning of the optional second and third parameters to this method are defined in the ECMA-402 specification; implementations that do not include ECMA-402 support must not assign any other interpretation to those parameter positions.

The actual return values are implementation-defined to permit encoding additional information in them, but this method, when considered as a method of two arguments, is required to be a consistent comparator defining a total ordering on the set of all Strings. This method is also required to recognize and honour canonical equivalence according to the Unicode Standard, including returning +0𝔽 when comparing distinguishable Strings that are canonically equivalent.

Note 1

This method itself is not directly suitable as an argument to Array.prototype.sort because the latter requires a function of two arguments.

Note 2

This method may rely on whatever language- and/or locale-sensitive comparison functionality is available to the ECMAScript environment from the host environment, and is intended to compare according to the conventions of the host environment's current locale. However, regardless of comparison capabilities, this method must recognize and honour canonical equivalence according to the Unicode Standard—for example, the following comparisons must all return +0𝔽:

// Å ANGSTROM SIGN vs.
// Å LATIN CAPITAL LETTER A + COMBINING RING ABOVE
"\u212B".localeCompare("A\u030A")

// Ω OHM SIGN vs.
// Ω GREEK CAPITAL LETTER OMEGA
"\u2126".localeCompare("\u03A9")

// ṩ LATIN SMALL LETTER S WITH DOT BELOW AND DOT ABOVE vs.
// ṩ LATIN SMALL LETTER S + COMBINING DOT ABOVE + COMBINING DOT BELOW
"\u1E69".localeCompare("s\u0307\u0323")

// ḍ̇ LATIN SMALL LETTER D WITH DOT ABOVE + COMBINING DOT BELOW vs.
// ḍ̇ LATIN SMALL LETTER D WITH DOT BELOW + COMBINING DOT ABOVE
"\u1E0B\u0323".localeCompare("\u1E0D\u0307")

// 가 HANGUL CHOSEONG KIYEOK + HANGUL JUNGSEONG A vs.
// 가 HANGUL SYLLABLE GA
"\u1100\u1161".localeCompare("\uAC00")

For a definition and discussion of canonical equivalence see the Unicode Standard, chapters 2 and 3, as well as Unicode Standard Annex #15, Unicode Normalization Forms and Unicode Technical Note #5, Canonical Equivalence in Applications. Also see Unicode Technical Standard #10, Unicode Collation Algorithm.

It is recommended that this method should not honour Unicode compatibility equivalents or compatibility decompositions as defined in the Unicode Standard, chapter 3, section 3.7.

Note 3

This method is intentionally generic; it does not require that its this value be a String object. Therefore, it can be transferred to other kinds of objects for use as a method.

22.1.3.13 String.prototype.match ( regexp )

This method performs the following steps when called:

  1. Let O be ? RequireObjectCoercible(this value).
  2. If regexp is neither undefined nor null, then
    1. Let matcher be ? GetMethod(regexp, %Symbol.match%).
    2. If matcher is not undefined, then
      1. Return ? Call(matcher, regexp, « O »).
  3. Let S be ? ToString(O).
  4. Let rx be ? RegExpCreate(regexp, undefined).
  5. Return ? Invoke(rx, %Symbol.match%, « S »).
Note

This method is intentionally generic; it does not require that its this value be a String object. Therefore, it can be transferred to other kinds of objects for use as a method.

22.1.3.14 String.prototype.matchAll ( regexp )

This method performs a regular expression match of the String representing the this value against regexp and returns an iterator that yields match results. Each match result is an Array containing the matched portion of the String as the first element, followed by the portions matched by any capturing groups. If the regular expression never matches, the returned iterator does not yield any match results.

It performs the following steps when called:

  1. Let O be ? RequireObjectCoercible(this value).
  2. If regexp is neither undefined nor null, then
    1. Let isRegExp be ? IsRegExp(regexp).
    2. If isRegExp is true, then
      1. Let flags be ? Get(regexp, "flags").
      2. Perform ? RequireObjectCoercible(flags).
      3. If ? ToString(flags) does not contain "g", throw a TypeError exception.
    3. Let matcher be ? GetMethod(regexp, %Symbol.matchAll%).
    4. If matcher is not undefined, then
      1. Return ? Call(matcher, regexp, « O »).
  3. Let S be ? ToString(O).
  4. Let rx be ? RegExpCreate(regexp, "g").
  5. Return ? Invoke(rx, %Symbol.matchAll%, « S »).
Note 1
This method is intentionally generic, it does not require that its this value be a String object. Therefore, it can be transferred to other kinds of objects for use as a method.
Note 2
Similarly to String.prototype.split, String.prototype.matchAll is designed to typically act without mutating its inputs.

22.1.3.15 String.prototype.normalize ( [ form ] )

This method performs the following steps when called:

  1. Let O be ? RequireObjectCoercible(this value).
  2. Let S be ? ToString(O).
  3. If form is undefined, let f be "NFC".
  4. Else, let f be ? ToString(form).
  5. If f is not one of "NFC", "NFD", "NFKC", or "NFKD", throw a RangeError exception.
  6. Let ns be the String value that is the result of normalizing S into the normalization form named by f as specified in the latest Unicode Standard, Normalization Forms.
  7. Return ns.
Note

This method is intentionally generic; it does not require that its this value be a String object. Therefore it can be transferred to other kinds of objects for use as a method.

22.1.3.16 String.prototype.padEnd ( maxLength [ , fillString ] )

This method performs the following steps when called:

  1. Let O be ? RequireObjectCoercible(this value).
  2. Return ? StringPaddingBuiltinsImpl(O, maxLength, fillString, end).

22.1.3.17 String.prototype.padStart ( maxLength [ , fillString ] )

This method performs the following steps when called:

  1. Let O be ? RequireObjectCoercible(this value).
  2. Return ? StringPaddingBuiltinsImpl(O, maxLength, fillString, start).

22.1.3.17.1 StringPaddingBuiltinsImpl ( O, maxLength, fillString, placement )

The abstract operation StringPaddingBuiltinsImpl takes arguments O (an ECMAScript language value), maxLength (an ECMAScript language value), fillString (an ECMAScript language value), and placement (start or end) and returns either a normal completion containing a String or a throw completion. It performs the following steps when called:

  1. Let S be ? ToString(O).
  2. Let intMaxLength be (? ToLength(maxLength)).
  3. Let stringLength be the length of S.
  4. If intMaxLengthstringLength, return S.
  5. If fillString is undefined, set fillString to the String value consisting solely of the code unit 0x0020 (SPACE).
  6. Else, set fillString to ? ToString(fillString).
  7. Return StringPad(S, intMaxLength, fillString, placement).

22.1.3.17.2 StringPad ( S, maxLength, fillString, placement )

The abstract operation StringPad takes arguments S (a String), maxLength (a non-negative integer), fillString (a String), and placement (start or end) and returns a String. It performs the following steps when called:

  1. Let stringLength be the length of S.
  2. If maxLengthstringLength, return S.
  3. If fillString is the empty String, return S.
  4. Let fillLen be maxLength - stringLength.
  5. Let truncatedStringFiller be the String value consisting of repeated concatenations of fillString truncated to length fillLen.
  6. If placement is start, return the string-concatenation of truncatedStringFiller and S.
  7. Else, return the string-concatenation of S and truncatedStringFiller.
Note 1

The argument maxLength will be clamped such that it can be no smaller than the length of S.

Note 2

The argument fillString defaults to " " (the String value consisting of the code unit 0x0020 SPACE).

22.1.3.17.3 ToZeroPaddedDecimalString ( n, minLength )

The abstract operation ToZeroPaddedDecimalString takes arguments n (a non-negative integer) and minLength (a non-negative integer) and returns a String. It performs the following steps when called:

  1. Let S be the String representation of n, formatted as a decimal number.
  2. Return StringPad(S, minLength, "0", start).

22.1.3.18 String.prototype.repeat ( count )

This method performs the following steps when called:

  1. Let O be ? RequireObjectCoercible(this value).
  2. Let S be ? ToString(O).
  3. Let n be ? ToIntegerOrInfinity(count).
  4. If n < 0 or n = +∞, throw a RangeError exception.
  5. If n = 0, return the empty String.
  6. Return the String value that is made from n copies of S appended together.
Note 1

This method creates the String value consisting of the code units of the this value (converted to String) repeated count times.

Note 2

This method is intentionally generic; it does not require that its this value be a String object. Therefore, it can be transferred to other kinds of objects for use as a method.

22.1.3.19 String.prototype.replace ( searchValue, replaceValue )

This method performs the following steps when called:

  1. Let O be ? RequireObjectCoercible(this value).
  2. If searchValue is neither undefined nor null, then
    1. Let replacer be ? GetMethod(searchValue, %Symbol.replace%).
    2. If replacer is not undefined, then
      1. Return ? Call(replacer, searchValue, « O, replaceValue »).
  3. Let string be ? ToString(O).
  4. Let searchString be ? ToString(searchValue).
  5. Let functionalReplace be IsCallable(replaceValue).
  6. If functionalReplace is false, then
    1. Set replaceValue to ? ToString(replaceValue).
  7. Let searchLength be the length of searchString.
  8. Let position be StringIndexOf(string, searchString, 0).
  9. If position is not-found, return string.
  10. Let preceding be the substring of string from 0 to position.
  11. Let following be the substring of string from position + searchLength.
  12. If functionalReplace is true, then
    1. Let replacement be ? ToString(? Call(replaceValue, undefined, « searchString, 𝔽(position), string »)).
  13. Else,
    1. Assert: replaceValue is a String.
    2. Let captures be a new empty List.
    3. Let replacement be ! GetSubstitution(searchString, string, position, captures, undefined, replaceValue).
  14. Return the string-concatenation of preceding, replacement, and following.
Note

This method is intentionally generic; it does not require that its this value be a String object. Therefore, it can be transferred to other kinds of objects for use as a method.

22.1.3.19.1 GetSubstitution ( matched, str, position, captures, namedCaptures, replacementTemplate )

The abstract operation GetSubstitution takes arguments matched (a String), str (a String), position (a non-negative integer), captures (a List of either Strings or undefined), namedCaptures (an Object or undefined), and replacementTemplate (a String) and returns either a normal completion containing a String or a throw completion. For the purposes of this abstract operation, a decimal digit is a code unit in the inclusive interval from 0x0030 (DIGIT ZERO) to 0x0039 (DIGIT NINE). It performs the following steps when called:

  1. Let stringLength be the length of str.
  2. Assert: positionstringLength.
  3. Let result be the empty String.
  4. Let templateRemainder be replacementTemplate.
  5. Repeat, while templateRemainder is not the empty String,
    1. NOTE: The following steps isolate ref (a prefix of templateRemainder), determine refReplacement (its replacement), and then append that replacement to result.
    2. If templateRemainder starts with "$$", then
      1. Let ref be "$$".
      2. Let refReplacement be "$".
    3. Else if templateRemainder starts with "$`", then
      1. Let ref be "$`".
      2. Let refReplacement be the substring of str from 0 to position.
    4. Else if templateRemainder starts with "$&", then
      1. Let ref be "$&".
      2. Let refReplacement be matched.
    5. Else if templateRemainder starts with "$'" (0x0024 (DOLLAR SIGN) followed by 0x0027 (APOSTROPHE)), then
      1. Let ref be "$'".
      2. Let matchLength be the length of matched.
      3. Let tailPos be position + matchLength.
      4. Let refReplacement be the substring of str from min(tailPos, stringLength).
      5. NOTE: tailPos can exceed stringLength only if this abstract operation was invoked by a call to the intrinsic %Symbol.replace% method of %RegExp.prototype% on an object whose "exec" property is not the intrinsic %RegExp.prototype.exec%.
    6. Else if templateRemainder starts with "$" followed by 1 or more decimal digits, then
      1. If templateRemainder starts with "$" followed by 2 or more decimal digits, let digitCount be 2; otherwise let digitCount be 1.
      2. Let digits be the substring of templateRemainder from 1 to 1 + digitCount.
      3. Let index be (StringToNumber(digits)).
      4. Assert: 0 ≤ index ≤ 99.
      5. Let captureLen be the number of elements in captures.
      6. If index > captureLen and digitCount = 2, then
        1. NOTE: When a two-digit replacement pattern specifies an index exceeding the count of capturing groups, it is treated as a one-digit replacement pattern followed by a literal digit.
        2. Set digitCount to 1.
        3. Set digits to the substring of digits from 0 to 1.
        4. Set index to (StringToNumber(digits)).
      7. Let ref be the substring of templateRemainder from 0 to 1 + digitCount.
      8. If 1 ≤ indexcaptureLen, then
        1. Let capture be captures[index - 1].
        2. If capture is undefined, then
          1. Let refReplacement be the empty String.
        3. Else,
          1. Let refReplacement be capture.
      9. Else,
        1. Let refReplacement be ref.
    7. Else if templateRemainder starts with "$<", then
      1. Let gtPos be StringIndexOf(templateRemainder, ">", 0).
      2. If gtPos is not-found or namedCaptures is undefined, then
        1. Let ref be "$<".
        2. Let refReplacement be ref.
      3. Else,
        1. Let ref be the substring of templateRemainder from 0 to gtPos + 1.
        2. Let groupName be the substring of templateRemainder from 2 to gtPos.
        3. Assert: namedCaptures is an Object.
        4. Let capture be ? Get(namedCaptures, groupName).
        5. If capture is undefined, then
          1. Let refReplacement be the empty String.
        6. Else,
          1. Let refReplacement be ? ToString(capture).
    8. Else,
      1. Let ref be the substring of templateRemainder from 0 to 1.
      2. Let refReplacement be ref.
    9. Let refLength be the length of ref.
    10. Set templateRemainder to the substring of templateRemainder from refLength.
    11. Set result to the string-concatenation of result and refReplacement.
  6. Return result.

22.1.3.20 String.prototype.replaceAll ( searchValue, replaceValue )

This method performs the following steps when called:

  1. Let O be ? RequireObjectCoercible(this value).
  2. If searchValue is neither undefined nor null, then
    1. Let isRegExp be ? IsRegExp(searchValue).
    2. If isRegExp is true, then
      1. Let flags be ? Get(searchValue, "flags").
      2. Perform ? RequireObjectCoercible(flags).
      3. If ? ToString(flags) does not contain "g", throw a TypeError exception.
    3. Let replacer be ? GetMethod(searchValue, %Symbol.replace%).
    4. If replacer is not undefined, then
      1. Return ? Call(replacer, searchValue, « O, replaceValue »).
  3. Let string be ? ToString(O).
  4. Let searchString be ? ToString(searchValue).
  5. Let functionalReplace be IsCallable(replaceValue).
  6. If functionalReplace is false, then
    1. Set replaceValue to ? ToString(replaceValue).
  7. Let searchLength be the length of searchString.
  8. Let advanceBy be max(1, searchLength).
  9. Let matchPositions be a new empty List.
  10. Let position be StringIndexOf(string, searchString, 0).
  11. Repeat, while position is not not-found,
    1. Append position to matchPositions.
    2. Set position to StringIndexOf(string, searchString, position + advanceBy).
  12. Let endOfLastMatch be 0.
  13. Let result be the empty String.
  14. For each element p of matchPositions, do
    1. Let preserved be the substring of string from endOfLastMatch to p.
    2. If functionalReplace is true, then
      1. Let replacement be ? ToString(? Call(replaceValue, undefined, « searchString, 𝔽(p), string »)).
    3. Else,
      1. Assert: replaceValue is a String.
      2. Let captures be a new empty List.
      3. Let replacement be ! GetSubstitution(searchString, string, p, captures, undefined, replaceValue).
    4. Set result to the string-concatenation of result, preserved, and replacement.
    5. Set endOfLastMatch to p + searchLength.
  15. If endOfLastMatch < the length of string, then
    1. Set result to the string-concatenation of result and the substring of string from endOfLastMatch.
  16. Return result.

22.1.3.21 String.prototype.search ( regexp )

This method performs the following steps when called:

  1. Let O be ? RequireObjectCoercible(this value).
  2. If regexp is neither undefined nor null, then
    1. Let searcher be ? GetMethod(regexp, %Symbol.search%).
    2. If searcher is not undefined, then
      1. Return ? Call(searcher, regexp, « O »).
  3. Let string be ? ToString(O).
  4. Let rx be ? RegExpCreate(regexp, undefined).
  5. Return ? Invoke(rx, %Symbol.search%, « string »).
Note

This method is intentionally generic; it does not require that its this value be a String object. Therefore, it can be transferred to other kinds of objects for use as a method.

22.1.3.22 String.prototype.slice ( start, end )

This method returns a substring of the result of converting this object to a String, starting from index start and running to, but not including, index end (or through the end of the String if end is undefined). If start is negative, it is treated as sourceLength + start where sourceLength is the length of the String. If end is negative, it is treated as sourceLength + end where sourceLength is the length of the String. The result is a String value, not a String object.

It performs the following steps when called:

  1. Let O be ? RequireObjectCoercible(this value).
  2. Let S be ? ToString(O).
  3. Let len be the length of S.
  4. Let intStart be ? ToIntegerOrInfinity(start).
  5. If intStart = -∞, let from be 0.
  6. Else if intStart < 0, let from be max(len + intStart, 0).
  7. Else, let from be min(intStart, len).
  8. If end is undefined, let intEnd be len; else let intEnd be ? ToIntegerOrInfinity(end).
  9. If intEnd = -∞, let to be 0.
  10. Else if intEnd < 0, let to be max(len + intEnd, 0).
  11. Else, let to be min(intEnd, len).
  12. If fromto, return the empty String.
  13. Return the substring of S from from to to.
Note

This method is intentionally generic; it does not require that its this value be a String object. Therefore it can be transferred to other kinds of objects for use as a method.

22.1.3.23 String.prototype.split ( separator, limit )

This method returns an Array into which substrings of the result of converting this object to a String have been stored. The substrings are determined by searching from left to right for occurrences of separator; these occurrences are not part of any String in the returned array, but serve to divide up the String value. The value of separator may be a String of any length or it may be an object, such as a RegExp, that has a %Symbol.split% method.

It performs the following steps when called:

  1. Let O be ? RequireObjectCoercible(this value).
  2. If separator is neither undefined nor null, then
    1. Let splitter be ? GetMethod(separator, %Symbol.split%).
    2. If splitter is not undefined, then
      1. Return ? Call(splitter, separator, « O, limit »).
  3. Let S be ? ToString(O).
  4. If limit is undefined, let lim be 232 - 1; else let lim be (? ToUint32(limit)).
  5. Let R be ? ToString(separator).
  6. If lim = 0, then
    1. Return CreateArrayFromList(« »).
  7. If separator is undefined, then
    1. Return CreateArrayFromListS »).
  8. Let separatorLength be the length of R.
  9. If separatorLength = 0, then
    1. Let strLen be the length of S.
    2. Let outLen be the result of clamping lim between 0 and strLen.
    3. Let head be the substring of S from 0 to outLen.
    4. Let codeUnits be a List consisting of the sequence of code units that are the elements of head.
    5. Return CreateArrayFromList(codeUnits).
  10. If S is the empty String, return CreateArrayFromListS »).
  11. Let substrings be a new empty List.
  12. Let i be 0.
  13. Let j be StringIndexOf(S, R, 0).
  14. Repeat, while j is not not-found,
    1. Let T be the substring of S from i to j.
    2. Append T to substrings.
    3. If the number of elements in substrings is lim, return CreateArrayFromList(substrings).
    4. Set i to j + separatorLength.
    5. Set j to StringIndexOf(S, R, i).
  15. Let T be the substring of S from i.
  16. Append T to substrings.
  17. Return CreateArrayFromList(substrings).
Note 1

The value of separator may be an empty String. In this case, separator does not match the empty substring at the beginning or end of the input String, nor does it match the empty substring at the end of the previous separator match. If separator is the empty String, the String is split up into individual code unit elements; the length of the result array equals the length of the String, and each substring contains one code unit.

If the this value is (or converts to) the empty String, the result depends on whether separator can match the empty String. If it can, the result array contains no elements. Otherwise, the result array contains one element, which is the empty String.

If separator is undefined, then the result array contains just one String, which is the this value (converted to a String). If limit is not undefined, then the output array is truncated so that it contains no more than limit elements.

Note 2

This method is intentionally generic; it does not require that its this value be a String object. Therefore, it can be transferred to other kinds of objects for use as a method.

22.1.3.24 String.prototype.startsWith ( searchString [ , position ] )

This method performs the following steps when called:

  1. Let O be ? RequireObjectCoercible(this value).
  2. Let S be ? ToString(O).
  3. Let isRegExp be ? IsRegExp(searchString).
  4. If isRegExp is true, throw a TypeError exception.
  5. Let searchStr be ? ToString(searchString).
  6. Let len be the length of S.
  7. If position is undefined, let pos be 0; else let pos be ? ToIntegerOrInfinity(position).
  8. Let start be the result of clamping pos between 0 and len.
  9. Let searchLength be the length of searchStr.
  10. If searchLength = 0, return true.
  11. Let end be start + searchLength.
  12. If end > len, return false.
  13. Let substring be the substring of S from start to end.
  14. If substring is searchStr, return true.
  15. Return false.
Note 1

This method returns true if the sequence of code units of searchString converted to a String is the same as the corresponding code units of this object (converted to a String) starting at index position. Otherwise it returns false.

Note 2

Throwing an exception if the first argument is a RegExp is specified in order to allow future editions to define extensions that allow such argument values.

Note 3

This method is intentionally generic; it does not require that its this value be a String object. Therefore, it can be transferred to other kinds of objects for use as a method.

22.1.3.25 String.prototype.substring ( start, end )

This method returns a substring of the result of converting this object to a String, starting from index start and running to, but not including, index end of the String (or through the end of the String if end is undefined). The result is a String value, not a String object.

If either argument is NaN or negative, it is replaced with zero; if either argument is strictly greater than the length of the String, it is replaced with the length of the String.

If start is strictly greater than end, they are swapped.

It performs the following steps when called:

  1. Let O be ? RequireObjectCoercible(this value).
  2. Let S be ? ToString(O).
  3. Let len be the length of S.
  4. Let intStart be ? ToIntegerOrInfinity(start).
  5. If end is undefined, let intEnd be len; else let intEnd be ? ToIntegerOrInfinity(end).
  6. Let finalStart be the result of clamping intStart between 0 and len.
  7. Let finalEnd be the result of clamping intEnd between 0 and len.
  8. Let from be min(finalStart, finalEnd).
  9. Let to be max(finalStart, finalEnd).
  10. Return the substring of S from from to to.
Note

This method is intentionally generic; it does not require that its this value be a String object. Therefore, it can be transferred to other kinds of objects for use as a method.

22.1.3.26 String.prototype.toLocaleLowerCase ( [ reserved1 [ , reserved2 ] ] )

An ECMAScript implementation that includes the ECMA-402 Internationalization API must implement this method as specified in the ECMA-402 specification. If an ECMAScript implementation does not include the ECMA-402 API the following specification of this method is used:

This method interprets a String value as a sequence of UTF-16 encoded code points, as described in 6.1.4.

It works exactly the same as toLowerCase except that it is intended to yield a locale-sensitive result corresponding with conventions of the host environment's current locale. There will only be a difference in the few cases (such as Turkish) where the rules for that language conflict with the regular Unicode case mappings.

The meaning of the optional parameters to this method are defined in the ECMA-402 specification; implementations that do not include ECMA-402 support must not use those parameter positions for anything else.

Note

This method is intentionally generic; it does not require that its this value be a String object. Therefore, it can be transferred to other kinds of objects for use as a method.

22.1.3.27 String.prototype.toLocaleUpperCase ( [ reserved1 [ , reserved2 ] ] )

An ECMAScript implementation that includes the ECMA-402 Internationalization API must implement this method as specified in the ECMA-402 specification. If an ECMAScript implementation does not include the ECMA-402 API the following specification of this method is used:

This method interprets a String value as a sequence of UTF-16 encoded code points, as described in 6.1.4.

It works exactly the same as toUpperCase except that it is intended to yield a locale-sensitive result corresponding with conventions of the host environment's current locale. There will only be a difference in the few cases (such as Turkish) where the rules for that language conflict with the regular Unicode case mappings.

The meaning of the optional parameters to this method are defined in the ECMA-402 specification; implementations that do not include ECMA-402 support must not use those parameter positions for anything else.

Note

This method is intentionally generic; it does not require that its this value be a String object. Therefore, it can be transferred to other kinds of objects for use as a method.

22.1.3.28 String.prototype.toLowerCase ( )

This method interprets a String value as a sequence of UTF-16 encoded code points, as described in 6.1.4.

It performs the following steps when called:

  1. Let O be ? RequireObjectCoercible(this value).
  2. Let S be ? ToString(O).
  3. Let sText be StringToCodePoints(S).
  4. Let lowerText be toLowercase(sText), according to the Unicode Default Case Conversion algorithm.
  5. Let L be CodePointsToString(lowerText).
  6. Return L.

The result must be derived according to the locale-insensitive case mappings in the Unicode Character Database (this explicitly includes not only the file UnicodeData.txt, but also all locale-insensitive mappings in the file SpecialCasing.txt that accompanies it).

Note 1

The case mapping of some code points may produce multiple code points. In this case the result String may not be the same length as the source String. Because both toUpperCase and toLowerCase have context-sensitive behaviour, the methods are not symmetrical. In other words, s.toUpperCase().toLowerCase() is not necessarily equal to s.toLowerCase().

Note 2

This method is intentionally generic; it does not require that its this value be a String object. Therefore, it can be transferred to other kinds of objects for use as a method.

22.1.3.29 String.prototype.toString ( )

This method performs the following steps when called:

  1. Return ? ThisStringValue(this value).
Note

For a String object, this method happens to return the same thing as the valueOf method.

22.1.3.30 String.prototype.toUpperCase ( )

This method interprets a String value as a sequence of UTF-16 encoded code points, as described in 6.1.4.

It behaves in exactly the same way as String.prototype.toLowerCase, except that the String is mapped using the toUppercase algorithm of the Unicode Default Case Conversion.

Note

This method is intentionally generic; it does not require that its this value be a String object. Therefore, it can be transferred to other kinds of objects for use as a method.

22.1.3.31 String.prototype.toWellFormed ( )

This method returns a String representation of this object with all leading surrogates and trailing surrogates that are not part of a surrogate pair replaced with U+FFFD (REPLACEMENT CHARACTER).

It performs the following steps when called:

  1. Let O be ? RequireObjectCoercible(this value).
  2. Let S be ? ToString(O).
  3. Let strLen be the length of S.
  4. Let k be 0.
  5. Let result be the empty String.
  6. Repeat, while k < strLen,
    1. Let cp be CodePointAt(S, k).
    2. If cp.[[IsUnpairedSurrogate]] is true, then
      1. Set result to the string-concatenation of result and 0xFFFD (REPLACEMENT CHARACTER).
    3. Else,
      1. Set result to the string-concatenation of result and UTF16EncodeCodePoint(cp.[[CodePoint]]).
    4. Set k to k + cp.[[CodeUnitCount]].
  7. Return result.

22.1.3.32 String.prototype.trim ( )

This method interprets a String value as a sequence of UTF-16 encoded code points, as described in 6.1.4.

It performs the following steps when called:

  1. Let S be the this value.
  2. Return ? TrimString(S, start+end).
Note

This method is intentionally generic; it does not require that its this value be a String object. Therefore, it can be transferred to other kinds of objects for use as a method.

22.1.3.32.1 TrimString ( string, where )

The abstract operation TrimString takes arguments string (an ECMAScript language value) and where (start, end, or start+end) and returns either a normal completion containing a String or a throw completion. It interprets string as a sequence of UTF-16 encoded code points, as described in 6.1.4. It performs the following steps when called:

  1. Let str be ? RequireObjectCoercible(string).
  2. Let S be ? ToString(str).
  3. If where is start, then
    1. Let T be the String value that is a copy of S with leading white space removed.
  4. Else if where is end, then
    1. Let T be the String value that is a copy of S with trailing white space removed.
  5. Else,
    1. Assert: where is start+end.
    2. Let T be the String value that is a copy of S with both leading and trailing white space removed.
  6. Return T.

The definition of white space is the union of WhiteSpace and LineTerminator. When determining whether a Unicode code point is in Unicode general category “Space_Separator” (“Zs”), code unit sequences are interpreted as UTF-16 encoded code point sequences as specified in 6.1.4.

22.1.3.33 String.prototype.trimEnd ( )

This method interprets a String value as a sequence of UTF-16 encoded code points, as described in 6.1.4.

It performs the following steps when called:

  1. Let S be the this value.
  2. Return ? TrimString(S, end).
Note

This method is intentionally generic; it does not require that its this value be a String object. Therefore, it can be transferred to other kinds of objects for use as a method.

22.1.3.34 String.prototype.trimStart ( )

This method interprets a String value as a sequence of UTF-16 encoded code points, as described in 6.1.4.

It performs the following steps when called:

  1. Let S be the this value.
  2. Return ? TrimString(S, start).
Note

This method is intentionally generic; it does not require that its this value be a String object. Therefore, it can be transferred to other kinds of objects for use as a method.

22.1.3.35 String.prototype.valueOf ( )

This method performs the following steps when called:

  1. Return ? ThisStringValue(this value).

22.1.3.35.1 ThisStringValue ( value )

The abstract operation ThisStringValue takes argument value (an ECMAScript language value) and returns either a normal completion containing a String or a throw completion. It performs the following steps when called:

  1. If value is a String, return value.
  2. If value is an Object and value has a [[StringData]] internal slot, then
    1. Let s be value.[[StringData]].
    2. Assert: s is a String.
    3. Return s.
  3. Throw a TypeError exception.

22.1.3.36 String.prototype [ %Symbol.iterator% ] ( )

This method returns an iterator object that iterates over the code points of a String value, returning each code point as a String value.

It performs the following steps when called:

  1. Let O be ? RequireObjectCoercible(this value).
  2. Let s be ? ToString(O).
  3. Let closure be a new Abstract Closure with no parameters that captures s and performs the following steps when called:
    1. Let len be the length of s.
    2. Let position be 0.
    3. Repeat, while position < len,
      1. Let cp be CodePointAt(s, position).
      2. Let nextIndex be position + cp.[[CodeUnitCount]].
      3. Let resultString be the substring of s from position to nextIndex.
      4. Set position to nextIndex.
      5. Perform ? GeneratorYield(CreateIteratorResultObject(resultString, false)).
    4. Return NormalCompletion(unused).
  4. Return CreateIteratorFromClosure(closure, "%StringIteratorPrototype%", %StringIteratorPrototype%).

The value of the "name" property of this method is "[Symbol.iterator]".

22.1.4 Properties of String Instances

String instances are String exotic objects and have the internal methods specified for such objects. String instances inherit properties from the String prototype object. String instances also have a [[StringData]] internal slot. The [[StringData]] internal slot is the String value represented by this String object.

String instances have a "length" property, and a set of enumerable properties with integer-indexed names.

22.1.4.1 length

The number of elements in the String value represented by this String object.

Once a String object is initialized, this property is unchanging. It has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: false }.

22.1.5 String Iterator Objects

A String Iterator is an object that represents a specific iteration over some specific String instance object. There is not a named constructor for String Iterator objects. Instead, String Iterator objects are created by calling certain methods of String instance objects.

22.1.5.1 The %StringIteratorPrototype% Object

The %StringIteratorPrototype% object:

22.1.5.1.1 %StringIteratorPrototype%.next ( )

  1. Return ? GeneratorResume(this value, empty, "%StringIteratorPrototype%").

22.1.5.1.2 %StringIteratorPrototype% [ %Symbol.toStringTag% ]

The initial value of the %Symbol.toStringTag% property is the String value "String Iterator".

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: true }.

22.2 RegExp (Regular Expression) Objects

A RegExp object contains a regular expression and the associated flags.

Note

The form and functionality of regular expressions is modelled after the regular expression facility in the Perl 5 programming language.

22.2.1 Patterns

The RegExp constructor applies the following grammar to the input pattern String. An error occurs if the grammar cannot interpret the String as an expansion of Pattern.

Syntax

Pattern[UnicodeMode, UnicodeSetsMode, NamedCaptureGroups] :: Disjunction[?UnicodeMode, ?UnicodeSetsMode, ?NamedCaptureGroups] Disjunction[UnicodeMode, UnicodeSetsMode, NamedCaptureGroups] :: Alternative[?UnicodeMode, ?UnicodeSetsMode, ?NamedCaptureGroups] Alternative[?UnicodeMode, ?UnicodeSetsMode, ?NamedCaptureGroups] | Disjunction[?UnicodeMode, ?UnicodeSetsMode, ?NamedCaptureGroups] Alternative[UnicodeMode, UnicodeSetsMode, NamedCaptureGroups] :: [empty] Alternative[?UnicodeMode, ?UnicodeSetsMode, ?NamedCaptureGroups] Term[?UnicodeMode, ?UnicodeSetsMode, ?NamedCaptureGroups] Term[UnicodeMode, UnicodeSetsMode, NamedCaptureGroups] :: Assertion[?UnicodeMode, ?UnicodeSetsMode, ?NamedCaptureGroups] Atom[?UnicodeMode, ?UnicodeSetsMode, ?NamedCaptureGroups] Atom[?UnicodeMode, ?UnicodeSetsMode, ?NamedCaptureGroups] Quantifier Assertion[UnicodeMode, UnicodeSetsMode, NamedCaptureGroups] :: ^ $ \b \B (?= Disjunction[?UnicodeMode, ?UnicodeSetsMode, ?NamedCaptureGroups] ) (?! Disjunction[?UnicodeMode, ?UnicodeSetsMode, ?NamedCaptureGroups] ) (?<= Disjunction[?UnicodeMode, ?UnicodeSetsMode, ?NamedCaptureGroups] ) (?<! Disjunction[?UnicodeMode, ?UnicodeSetsMode, ?NamedCaptureGroups] ) Quantifier :: QuantifierPrefix QuantifierPrefix ? QuantifierPrefix :: * + ? { DecimalDigits[~Sep] } { DecimalDigits[~Sep] ,} { DecimalDigits[~Sep] , DecimalDigits[~Sep] } Atom[UnicodeMode, UnicodeSetsMode, NamedCaptureGroups] :: PatternCharacter . \ AtomEscape[?UnicodeMode, ?NamedCaptureGroups] CharacterClass[?UnicodeMode, ?UnicodeSetsMode] ( GroupSpecifier[?UnicodeMode]opt Disjunction[?UnicodeMode, ?UnicodeSetsMode, ?NamedCaptureGroups] ) (? RegularExpressionModifiers : Disjunction[?UnicodeMode, ?UnicodeSetsMode, ?NamedCaptureGroups] ) (? RegularExpressionModifiers - RegularExpressionModifiers : Disjunction[?UnicodeMode, ?UnicodeSetsMode, ?NamedCaptureGroups] ) RegularExpressionModifiers :: [empty] RegularExpressionModifiers RegularExpressionModifier RegularExpressionModifier :: one of i m s SyntaxCharacter :: one of ^ $ \ . * + ? ( ) [ ] { } | PatternCharacter :: SourceCharacter but not SyntaxCharacter AtomEscape[UnicodeMode, NamedCaptureGroups] :: DecimalEscape CharacterClassEscape[?UnicodeMode] CharacterEscape[?UnicodeMode] [+NamedCaptureGroups] k GroupName[?UnicodeMode] CharacterEscape[UnicodeMode] :: ControlEscape c AsciiLetter 0 [lookahead ∉ DecimalDigit] HexEscapeSequence RegExpUnicodeEscapeSequence[?UnicodeMode] IdentityEscape[?UnicodeMode] ControlEscape :: one of f n r t v GroupSpecifier[UnicodeMode] :: ? GroupName[?UnicodeMode] GroupName[UnicodeMode] :: < RegExpIdentifierName[?UnicodeMode] > RegExpIdentifierName[UnicodeMode] :: RegExpIdentifierStart[?UnicodeMode] RegExpIdentifierName[?UnicodeMode] RegExpIdentifierPart[?UnicodeMode] RegExpIdentifierStart[UnicodeMode] :: IdentifierStartChar \ RegExpUnicodeEscapeSequence[+UnicodeMode] [~UnicodeMode] UnicodeLeadSurrogate UnicodeTrailSurrogate RegExpIdentifierPart[UnicodeMode] :: IdentifierPartChar \ RegExpUnicodeEscapeSequence[+UnicodeMode] [~UnicodeMode] UnicodeLeadSurrogate UnicodeTrailSurrogate RegExpUnicodeEscapeSequence[UnicodeMode] :: [+UnicodeMode] u HexLeadSurrogate \u HexTrailSurrogate [+UnicodeMode] u HexLeadSurrogate [+UnicodeMode] u HexTrailSurrogate [+UnicodeMode] u HexNonSurrogate [~UnicodeMode] u Hex4Digits [+UnicodeMode] u{ CodePoint } UnicodeLeadSurrogate :: any Unicode code point in the inclusive interval from U+D800 to U+DBFF UnicodeTrailSurrogate :: any Unicode code point in the inclusive interval from U+DC00 to U+DFFF

Each \u HexTrailSurrogate for which the choice of associated u HexLeadSurrogate is ambiguous shall be associated with the nearest possible u HexLeadSurrogate that would otherwise have no corresponding \u HexTrailSurrogate.

HexLeadSurrogate :: Hex4Digits but only if the MV of Hex4Digits is in the inclusive interval from 0xD800 to 0xDBFF HexTrailSurrogate :: Hex4Digits but only if the MV of Hex4Digits is in the inclusive interval from 0xDC00 to 0xDFFF HexNonSurrogate :: Hex4Digits but only if the MV of Hex4Digits is not in the inclusive interval from 0xD800 to 0xDFFF IdentityEscape[UnicodeMode] :: [+UnicodeMode] SyntaxCharacter [+UnicodeMode] / [~UnicodeMode] SourceCharacter but not UnicodeIDContinue DecimalEscape :: NonZeroDigit DecimalDigits[~Sep]opt [lookahead ∉ DecimalDigit] CharacterClassEscape[UnicodeMode] :: d D s S w W [+UnicodeMode] p{ UnicodePropertyValueExpression } [+UnicodeMode] P{ UnicodePropertyValueExpression } UnicodePropertyValueExpression :: UnicodePropertyName = UnicodePropertyValue LoneUnicodePropertyNameOrValue UnicodePropertyName :: UnicodePropertyNameCharacters UnicodePropertyNameCharacters :: UnicodePropertyNameCharacter UnicodePropertyNameCharactersopt UnicodePropertyValue :: UnicodePropertyValueCharacters LoneUnicodePropertyNameOrValue :: UnicodePropertyValueCharacters UnicodePropertyValueCharacters :: UnicodePropertyValueCharacter UnicodePropertyValueCharactersopt UnicodePropertyValueCharacter :: UnicodePropertyNameCharacter DecimalDigit UnicodePropertyNameCharacter :: AsciiLetter _ CharacterClass[UnicodeMode, UnicodeSetsMode] :: [ [lookahead ≠ ^] ClassContents[?UnicodeMode, ?UnicodeSetsMode] ] [^ ClassContents[?UnicodeMode, ?UnicodeSetsMode] ] ClassContents[UnicodeMode, UnicodeSetsMode] :: [empty] [~UnicodeSetsMode] NonemptyClassRanges[?UnicodeMode] [+UnicodeSetsMode] ClassSetExpression NonemptyClassRanges[UnicodeMode] :: ClassAtom[?UnicodeMode] ClassAtom[?UnicodeMode] NonemptyClassRangesNoDash[?UnicodeMode] ClassAtom[?UnicodeMode] - ClassAtom[?UnicodeMode] ClassContents[?UnicodeMode, ~UnicodeSetsMode] NonemptyClassRangesNoDash[UnicodeMode] :: ClassAtom[?UnicodeMode] ClassAtomNoDash[?UnicodeMode] NonemptyClassRangesNoDash[?UnicodeMode] ClassAtomNoDash[?UnicodeMode] - ClassAtom[?UnicodeMode] ClassContents[?UnicodeMode, ~UnicodeSetsMode] ClassAtom[UnicodeMode] :: - ClassAtomNoDash[?UnicodeMode] ClassAtomNoDash[UnicodeMode] :: SourceCharacter but not one of \ or ] or - \ ClassEscape[?UnicodeMode] ClassEscape[UnicodeMode] :: b [+UnicodeMode] - CharacterClassEscape[?UnicodeMode] CharacterEscape[?UnicodeMode] ClassSetExpression :: ClassUnion ClassIntersection ClassSubtraction ClassUnion :: ClassSetRange ClassUnionopt ClassSetOperand ClassUnionopt ClassIntersection :: ClassSetOperand && [lookahead ≠ &] ClassSetOperand ClassIntersection && [lookahead ≠ &] ClassSetOperand ClassSubtraction :: ClassSetOperand -- ClassSetOperand ClassSubtraction -- ClassSetOperand ClassSetRange :: ClassSetCharacter - ClassSetCharacter ClassSetOperand :: NestedClass ClassStringDisjunction ClassSetCharacter NestedClass :: [ [lookahead ≠ ^] ClassContents[+UnicodeMode, +UnicodeSetsMode] ] [^ ClassContents[+UnicodeMode, +UnicodeSetsMode] ] \ CharacterClassEscape[+UnicodeMode] Note 1

The first two lines here are equivalent to CharacterClass.

ClassStringDisjunction :: \q{ ClassStringDisjunctionContents } ClassStringDisjunctionContents :: ClassString ClassString | ClassStringDisjunctionContents ClassString :: [empty] NonEmptyClassString NonEmptyClassString :: ClassSetCharacter NonEmptyClassStringopt ClassSetCharacter :: [lookahead ∉ ClassSetReservedDoublePunctuator] SourceCharacter but not ClassSetSyntaxCharacter \ CharacterEscape[+UnicodeMode] \ ClassSetReservedPunctuator \b ClassSetReservedDoublePunctuator :: one of && !! ## $$ %% ** ++ ,, .. :: ;; << == >> ?? @@ ^^ `` ~~ ClassSetSyntaxCharacter :: one of ( ) [ ] { } / - \ | ClassSetReservedPunctuator :: one of & - ! # % , : ; < = > @ ` ~ Note 2

A number of productions in this section are given alternative definitions in section B.1.2.

22.2.1.1 Static Semantics: Early Errors

Note

This section is amended in B.1.2.1.

Pattern :: Disjunction QuantifierPrefix :: { DecimalDigits , DecimalDigits } Atom :: (? RegularExpressionModifiers : Disjunction ) Atom :: (? RegularExpressionModifiers - RegularExpressionModifiers : Disjunction ) AtomEscape :: k GroupName AtomEscape :: DecimalEscape NonemptyClassRanges :: ClassAtom - ClassAtom ClassContents NonemptyClassRangesNoDash :: ClassAtomNoDash - ClassAtom ClassContents RegExpIdentifierStart :: \ RegExpUnicodeEscapeSequence RegExpIdentifierStart :: UnicodeLeadSurrogate UnicodeTrailSurrogate RegExpIdentifierPart :: \ RegExpUnicodeEscapeSequence RegExpIdentifierPart :: UnicodeLeadSurrogate UnicodeTrailSurrogate UnicodePropertyValueExpression :: UnicodePropertyName = UnicodePropertyValue UnicodePropertyValueExpression :: LoneUnicodePropertyNameOrValue CharacterClassEscape :: P{ UnicodePropertyValueExpression } CharacterClass :: [^ ClassContents ] NestedClass :: [^ ClassContents ] ClassSetRange :: ClassSetCharacter - ClassSetCharacter

22.2.1.2 Static Semantics: CountLeftCapturingParensWithin ( node )

The abstract operation CountLeftCapturingParensWithin takes argument node (a Parse Node) and returns a non-negative integer. It returns the number of left-capturing parentheses in node. A left-capturing parenthesis is any ( pattern character that is matched by the ( terminal of the Atom :: ( GroupSpecifieropt Disjunction ) production.

Note

This section is amended in B.1.2.2.

It performs the following steps when called:

  1. Assert: node is an instance of a production in the RegExp Pattern grammar.
  2. Return the number of Atom :: ( GroupSpecifieropt Disjunction ) Parse Nodes contained within node.

22.2.1.3 Static Semantics: CountLeftCapturingParensBefore ( node )

The abstract operation CountLeftCapturingParensBefore takes argument node (a Parse Node) and returns a non-negative integer. It returns the number of left-capturing parentheses within the enclosing pattern that occur to the left of node.

Note

This section is amended in B.1.2.2.

It performs the following steps when called:

  1. Assert: node is an instance of a production in the RegExp Pattern grammar.
  2. Let pattern be the Pattern containing node.
  3. Return the number of Atom :: ( GroupSpecifieropt Disjunction ) Parse Nodes contained within pattern that either occur before node or contain node.

22.2.1.4 Static Semantics: MightBothParticipate ( x, y )

The abstract operation MightBothParticipate takes arguments x (a Parse Node) and y (a Parse Node) and returns a Boolean. It performs the following steps when called:

  1. Assert: x and y have the same enclosing Pattern.
  2. If the enclosing Pattern contains a Disjunction :: Alternative | Disjunction Parse Node such that either x is contained within the Alternative and y is contained within the derived Disjunction, or x is contained within the derived Disjunction and y is contained within the Alternative, return false.
  3. Return true.

22.2.1.5 Static Semantics: CapturingGroupNumber

The syntax-directed operation CapturingGroupNumber takes no arguments and returns a positive integer.

Note

This section is amended in B.1.2.1.

It is defined piecewise over the following productions:

DecimalEscape :: NonZeroDigit
  1. Return the MV of NonZeroDigit.
DecimalEscape :: NonZeroDigit DecimalDigits
  1. Let n be the number of code points in DecimalDigits.
  2. Return (the MV of NonZeroDigit × 10n plus the MV of DecimalDigits).

The definitions of “the MV of NonZeroDigit” and “the MV of DecimalDigits” are in 12.9.3.

22.2.1.6 Static Semantics: IsCharacterClass

The syntax-directed operation IsCharacterClass takes no arguments and returns a Boolean.

Note

This section is amended in B.1.2.3.

It is defined piecewise over the following productions:

ClassAtom :: - ClassAtomNoDash :: SourceCharacter but not one of \ or ] or - ClassEscape :: b - CharacterEscape
  1. Return false.
ClassEscape :: CharacterClassEscape
  1. Return true.

22.2.1.7 Static Semantics: CharacterValue

The syntax-directed operation CharacterValue takes no arguments and returns a non-negative integer.

Note 1

This section is amended in B.1.2.4.

It is defined piecewise over the following productions:

ClassAtom :: -
  1. Return the numeric value of U+002D (HYPHEN-MINUS).
ClassAtomNoDash :: SourceCharacter but not one of \ or ] or -
  1. Let ch be the code point matched by SourceCharacter.
  2. Return the numeric value of ch.
ClassEscape :: b
  1. Return the numeric value of U+0008 (BACKSPACE).
ClassEscape :: -
  1. Return the numeric value of U+002D (HYPHEN-MINUS).
CharacterEscape :: ControlEscape
  1. Return the numeric value according to Table 67.
Table 67: ControlEscape Code Point Values
ControlEscape Numeric Value Code Point Unicode Name Symbol
t 9 U+0009 CHARACTER TABULATION <HT>
n 10 U+000A LINE FEED (LF) <LF>
v 11 U+000B LINE TABULATION <VT>
f 12 U+000C FORM FEED (FF) <FF>
r 13 U+000D CARRIAGE RETURN (CR) <CR>
CharacterEscape :: c AsciiLetter
  1. Let ch be the code point matched by AsciiLetter.
  2. Let i be the numeric value of ch.
  3. Return the remainder of dividing i by 32.
CharacterEscape :: 0 [lookahead ∉ DecimalDigit]
  1. Return the numeric value of U+0000 (NULL).
Note 2

\0 represents the <NUL> character and cannot be followed by a decimal digit.

CharacterEscape :: HexEscapeSequence
  1. Return the MV of HexEscapeSequence.
RegExpUnicodeEscapeSequence :: u HexLeadSurrogate \u HexTrailSurrogate
  1. Let lead be the CharacterValue of HexLeadSurrogate.
  2. Let trail be the CharacterValue of HexTrailSurrogate.
  3. Let cp be UTF16SurrogatePairToCodePoint(lead, trail).
  4. Return the numeric value of cp.
RegExpUnicodeEscapeSequence :: u Hex4Digits
  1. Return the MV of Hex4Digits.
RegExpUnicodeEscapeSequence :: u{ CodePoint }
  1. Return the MV of CodePoint.
HexLeadSurrogate :: Hex4Digits HexTrailSurrogate :: Hex4Digits HexNonSurrogate :: Hex4Digits
  1. Return the MV of Hex4Digits.
CharacterEscape :: IdentityEscape
  1. Let ch be the code point matched by IdentityEscape.
  2. Return the numeric value of ch.
ClassSetCharacter :: SourceCharacter but not ClassSetSyntaxCharacter
  1. Let ch be the code point matched by SourceCharacter.
  2. Return the numeric value of ch.
ClassSetCharacter :: \ ClassSetReservedPunctuator
  1. Let ch be the code point matched by ClassSetReservedPunctuator.
  2. Return the numeric value of ch.
ClassSetCharacter :: \b
  1. Return the numeric value of U+0008 (BACKSPACE).

22.2.1.8 Static Semantics: MayContainStrings

The syntax-directed operation MayContainStrings takes no arguments and returns a Boolean. It is defined piecewise over the following productions:

CharacterClassEscape :: d D s S w W P{ UnicodePropertyValueExpression } UnicodePropertyValueExpression :: UnicodePropertyName = UnicodePropertyValue NestedClass :: [^ ClassContents ] ClassContents :: [empty] NonemptyClassRanges ClassSetOperand :: ClassSetCharacter
  1. Return false.
UnicodePropertyValueExpression :: LoneUnicodePropertyNameOrValue
  1. If the source text matched by LoneUnicodePropertyNameOrValue is a binary property of strings listed in the “Property name” column of Table 71, return true.
  2. Return false.
ClassUnion :: ClassSetRange ClassUnionopt
  1. If the ClassUnion is present, return MayContainStrings of the ClassUnion.
  2. Return false.
ClassUnion :: ClassSetOperand ClassUnionopt
  1. If MayContainStrings of the ClassSetOperand is true, return true.
  2. If ClassUnion is present, return MayContainStrings of the ClassUnion.
  3. Return false.
ClassIntersection :: ClassSetOperand && ClassSetOperand
  1. If MayContainStrings of the first ClassSetOperand is false, return false.
  2. If MayContainStrings of the second ClassSetOperand is false, return false.
  3. Return true.
ClassIntersection :: ClassIntersection && ClassSetOperand
  1. If MayContainStrings of the ClassIntersection is false, return false.
  2. If MayContainStrings of the ClassSetOperand is false, return false.
  3. Return true.
ClassSubtraction :: ClassSetOperand -- ClassSetOperand
  1. Return MayContainStrings of the first ClassSetOperand.
ClassSubtraction :: ClassSubtraction -- ClassSetOperand
  1. Return MayContainStrings of the ClassSubtraction.
ClassStringDisjunctionContents :: ClassString | ClassStringDisjunctionContents
  1. If MayContainStrings of the ClassString is true, return true.
  2. Return MayContainStrings of the ClassStringDisjunctionContents.
ClassString :: [empty]
  1. Return true.
ClassString :: NonEmptyClassString
  1. Return MayContainStrings of the NonEmptyClassString.
NonEmptyClassString :: ClassSetCharacter NonEmptyClassStringopt
  1. If NonEmptyClassString is present, return true.
  2. Return false.

22.2.1.9 Static Semantics: GroupSpecifiersThatMatch ( thisGroupName )

The abstract operation GroupSpecifiersThatMatch takes argument thisGroupName (a GroupName Parse Node) and returns a List of GroupSpecifier Parse Nodes. It performs the following steps when called:

  1. Let name be the CapturingGroupName of thisGroupName.
  2. Let pattern be the Pattern containing thisGroupName.
  3. Let result be a new empty List.
  4. For each GroupSpecifier gs that pattern contains, do
    1. If the CapturingGroupName of gs is name, then
      1. Append gs to result.
  5. Return result.

22.2.1.10 Static Semantics: CapturingGroupName

The syntax-directed operation CapturingGroupName takes no arguments and returns a String. It is defined piecewise over the following productions:

GroupName :: < RegExpIdentifierName >
  1. Let idTextUnescaped be the RegExpIdentifierCodePoints of RegExpIdentifierName.
  2. Return CodePointsToString(idTextUnescaped).

22.2.1.11 Static Semantics: RegExpIdentifierCodePoints

The syntax-directed operation RegExpIdentifierCodePoints takes no arguments and returns a List of code points. It is defined piecewise over the following productions:

RegExpIdentifierName :: RegExpIdentifierStart
  1. Let cp be the RegExpIdentifierCodePoint of RegExpIdentifierStart.
  2. Return « cp ».
RegExpIdentifierName :: RegExpIdentifierName RegExpIdentifierPart
  1. Let cps be the RegExpIdentifierCodePoints of the derived RegExpIdentifierName.
  2. Let cp be the RegExpIdentifierCodePoint of RegExpIdentifierPart.
  3. Return the list-concatenation of cps and « cp ».

22.2.1.12 Static Semantics: RegExpIdentifierCodePoint

The syntax-directed operation RegExpIdentifierCodePoint takes no arguments and returns a code point. It is defined piecewise over the following productions:

RegExpIdentifierStart :: IdentifierStartChar
  1. Return the code point matched by IdentifierStartChar.
RegExpIdentifierPart :: IdentifierPartChar
  1. Return the code point matched by IdentifierPartChar.
RegExpIdentifierStart :: \ RegExpUnicodeEscapeSequence RegExpIdentifierPart :: \ RegExpUnicodeEscapeSequence
  1. Return the code point whose numeric value is the CharacterValue of RegExpUnicodeEscapeSequence.
RegExpIdentifierStart :: UnicodeLeadSurrogate UnicodeTrailSurrogate RegExpIdentifierPart :: UnicodeLeadSurrogate UnicodeTrailSurrogate
  1. Let lead be the code unit whose numeric value is the numeric value of the code point matched by UnicodeLeadSurrogate.
  2. Let trail be the code unit whose numeric value is the numeric value of the code point matched by UnicodeTrailSurrogate.
  3. Return UTF16SurrogatePairToCodePoint(lead, trail).

22.2.2 Pattern Semantics

A regular expression pattern is converted into an Abstract Closure using the process described below. An implementation is encouraged to use more efficient algorithms than the ones listed below, as long as the results are the same. The Abstract Closure is used as the value of a RegExp object's [[RegExpMatcher]] internal slot.

A Pattern is a BMP pattern if its associated flags contain neither a u nor a v. Otherwise, it is a Unicode pattern. A BMP pattern matches against a String interpreted as consisting of a sequence of 16-bit values that are Unicode code points in the range of the Basic Multilingual Plane. A Unicode pattern matches against a String interpreted as consisting of Unicode code points encoded using UTF-16. In the context of describing the behaviour of a BMP pattern “character” means a single 16-bit Unicode BMP code point. In the context of describing the behaviour of a Unicode pattern “character” means a UTF-16 encoded code point (6.1.4). In either context, “character value” means the numeric value of the corresponding non-encoded code point.

The syntax and semantics of Pattern is defined as if the source text for the Pattern was a List of SourceCharacter values where each SourceCharacter corresponds to a Unicode code point. If a BMP pattern contains a non-BMP SourceCharacter the entire pattern is encoded using UTF-16 and the individual code units of that encoding are used as the elements of the List.

Note

For example, consider a pattern expressed in source text as the single non-BMP character U+1D11E (MUSICAL SYMBOL G CLEF). Interpreted as a Unicode pattern, it would be a single element (character) List consisting of the single code point U+1D11E. However, interpreted as a BMP pattern, it is first UTF-16 encoded to produce a two element List consisting of the code units 0xD834 and 0xDD1E.

Patterns are passed to the RegExp constructor as ECMAScript String values in which non-BMP characters are UTF-16 encoded. For example, the single character MUSICAL SYMBOL G CLEF pattern, expressed as a String value, is a String of length 2 whose elements were the code units 0xD834 and 0xDD1E. So no further translation of the string would be necessary to process it as a BMP pattern consisting of two pattern characters. However, to process it as a Unicode pattern UTF16SurrogatePairToCodePoint must be used in producing a List whose sole element is a single pattern character, the code point U+1D11E.

An implementation may not actually perform such translations to or from UTF-16, but the semantics of this specification requires that the result of pattern matching be as if such translations were performed.

22.2.2.1 Notation

The descriptions below use the following internal data structures:

  • A CharSetElement is one of the two following entities:
    • If rer.[[UnicodeSets]] is false, then a CharSetElement is a character in the sense of the Pattern Semantics above.
    • If rer.[[UnicodeSets]] is true, then a CharSetElement is a sequence whose elements are characters in the sense of the Pattern Semantics above. This includes the empty sequence, sequences of one character, and sequences of more than one character. For convenience, when working with CharSetElements of this kind, an individual character is treated interchangeably with a sequence of one character.
  • A CharSet is a mathematical set of CharSetElements.
  • A CaptureRange is a Record { [[StartIndex]], [[EndIndex]] } that represents the range of characters included in a capture, where [[StartIndex]] is an integer representing the start index (inclusive) of the range within Input, and [[EndIndex]] is an integer representing the end index (exclusive) of the range within Input. For any CaptureRange, these indices must satisfy the invariant that [[StartIndex]][[EndIndex]].
  • A MatchState is a Record { [[Input]], [[EndIndex]], [[Captures]] } where [[Input]] is a List of characters representing the String being matched, [[EndIndex]] is an integer, and [[Captures]] is a List of values, one for each left-capturing parenthesis in the pattern. MatchStates are used to represent partial match states in the regular expression matching algorithms. The [[EndIndex]] is one plus the index of the last input character matched so far by the pattern, while [[Captures]] holds the results of capturing parentheses. The nth element of [[Captures]] is either a CaptureRange representing the range of characters captured by the nth set of capturing parentheses, or undefined if the nth set of capturing parentheses hasn't been reached yet. Due to backtracking, many MatchStates may be in use at any time during the matching process.
  • A MatcherContinuation is an Abstract Closure that takes one MatchState argument and returns either a MatchState or failure. The MatcherContinuation attempts to match the remaining portion (specified by the closure's captured values) of the pattern against Input, starting at the intermediate state given by its MatchState argument. If the match succeeds, the MatcherContinuation returns the final MatchState that it reached; if the match fails, the MatcherContinuation returns failure.
  • A Matcher is an Abstract Closure that takes two arguments—a MatchState and a MatcherContinuation—and returns either a MatchState or failure. A Matcher attempts to match a middle subpattern (specified by the closure's captured values) of the pattern against the MatchState's [[Input]], starting at the intermediate state given by its MatchState argument. The MatcherContinuation argument should be a closure that matches the rest of the pattern. After matching the subpattern of a pattern to obtain a new MatchState, the Matcher then calls MatcherContinuation on that new MatchState to test if the rest of the pattern can match as well. If it can, the Matcher returns the MatchState returned by MatcherContinuation; if not, the Matcher may try different choices at its choice points, repeatedly calling MatcherContinuation until it either succeeds or all possibilities have been exhausted.

22.2.2.1.1 RegExp Records

A RegExp Record is a Record value used to store information about a RegExp that is needed during compilation and possibly during matching.

It has the following fields:

Table 68: RegExp Record Fields
Field Name Value Meaning
[[IgnoreCase]] a Boolean indicates whether "i" appears in the RegExp's flags
[[Multiline]] a Boolean indicates whether "m" appears in the RegExp's flags
[[DotAll]] a Boolean indicates whether "s" appears in the RegExp's flags
[[Unicode]] a Boolean indicates whether "u" appears in the RegExp's flags
[[UnicodeSets]] a Boolean indicates whether "v" appears in the RegExp's flags
[[CapturingGroupsCount]] a non-negative integer the number of left-capturing parentheses in the RegExp's pattern

22.2.2.2 Runtime Semantics: CompilePattern

The syntax-directed operation CompilePattern takes argument rer (a RegExp Record) and returns an Abstract Closure that takes a List of characters and a non-negative integer and returns either a MatchState or failure. It is defined piecewise over the following productions:

Pattern :: Disjunction
  1. Let m be CompileSubpattern of Disjunction with arguments rer and forward.
  2. Return a new Abstract Closure with parameters (Input, index) that captures rer and m and performs the following steps when called:
    1. Assert: Input is a List of characters.
    2. Assert: 0 ≤ index ≤ the number of elements in Input.
    3. Let c be a new MatcherContinuation with parameters (y) that captures nothing and performs the following steps when called:
      1. Assert: y is a MatchState.
      2. Return y.
    4. Let cap be a List of rer.[[CapturingGroupsCount]] undefined values, indexed 1 through rer.[[CapturingGroupsCount]].
    5. Let x be the MatchState { [[Input]]: Input, [[EndIndex]]: index, [[Captures]]: cap }.
    6. Return m(x, c).
Note

A Pattern compiles to an Abstract Closure value. RegExpBuiltinExec can then apply this procedure to a List of characters and an offset within that List to determine whether the pattern would match starting at exactly that offset within the List, and, if it does match, what the values of the capturing parentheses would be. The algorithms in 22.2.2 are designed so that compiling a pattern may throw a SyntaxError exception; on the other hand, once the pattern is successfully compiled, applying the resulting Abstract Closure to find a match in a List of characters cannot throw an exception (except for any implementation-defined exceptions that can occur anywhere such as out-of-memory).

22.2.2.3 Runtime Semantics: CompileSubpattern

The syntax-directed operation CompileSubpattern takes arguments rer (a RegExp Record) and direction (forward or backward) and returns a Matcher.

Note 1

This section is amended in B.1.2.5.

It is defined piecewise over the following productions:

Disjunction :: Alternative | Disjunction
  1. Let m1 be CompileSubpattern of Alternative with arguments rer and direction.
  2. Let m2 be CompileSubpattern of Disjunction with arguments rer and direction.
  3. Return MatchTwoAlternatives(m1, m2).
Note 2

The | regular expression operator separates two alternatives. The pattern first tries to match the left Alternative (followed by the sequel of the regular expression); if it fails, it tries to match the right Disjunction (followed by the sequel of the regular expression). If the left Alternative, the right Disjunction, and the sequel all have choice points, all choices in the sequel are tried before moving on to the next choice in the left Alternative. If choices in the left Alternative are exhausted, the right Disjunction is tried instead of the left Alternative. Any capturing parentheses inside a portion of the pattern skipped by | produce undefined values instead of Strings. Thus, for example,

/a|ab/.exec("abc")

returns the result "a" and not "ab". Moreover,

/((a)|(ab))((c)|(bc))/.exec("abc")

returns the array

["abc", "a", "a", undefined, "bc", undefined, "bc"]

and not

["abc", "ab", undefined, "ab", "c", "c", undefined]

The order in which the two alternatives are tried is independent of the value of direction.

Alternative :: [empty]
  1. Return EmptyMatcher().
Alternative :: Alternative Term
  1. Let m1 be CompileSubpattern of Alternative with arguments rer and direction.
  2. Let m2 be CompileSubpattern of Term with arguments rer and direction.
  3. Return MatchSequence(m1, m2, direction).
Note 3

Consecutive Terms try to simultaneously match consecutive portions of Input. When direction is forward, if the left Alternative, the right Term, and the sequel of the regular expression all have choice points, all choices in the sequel are tried before moving on to the next choice in the right Term, and all choices in the right Term are tried before moving on to the next choice in the left Alternative. When direction is backward, the evaluation order of Alternative and Term are reversed.

Term :: Assertion
  1. Return CompileAssertion of Assertion with argument rer.
Note 4

The resulting Matcher is independent of direction.

Term :: Atom
  1. Return CompileAtom of Atom with arguments rer and direction.
Term :: Atom Quantifier
  1. Let m be CompileAtom of Atom with arguments rer and direction.
  2. Let q be CompileQuantifier of Quantifier.
  3. Assert: q.[[Min]]q.[[Max]].
  4. Let parenIndex be CountLeftCapturingParensBefore(Term).
  5. Let parenCount be CountLeftCapturingParensWithin(Atom).
  6. Return a new Matcher with parameters (x, c) that captures m, q, parenIndex, and parenCount and performs the following steps when called:
    1. Assert: x is a MatchState.
    2. Assert: c is a MatcherContinuation.
    3. Return RepeatMatcher(m, q.[[Min]], q.[[Max]], q.[[Greedy]], x, c, parenIndex, parenCount).

22.2.2.3.1 RepeatMatcher ( m, min, max, greedy, x, c, parenIndex, parenCount )

The abstract operation RepeatMatcher takes arguments m (a Matcher), min (a non-negative integer), max (a non-negative integer or +∞), greedy (a Boolean), x (a MatchState), c (a MatcherContinuation), parenIndex (a non-negative integer), and parenCount (a non-negative integer) and returns either a MatchState or failure. It performs the following steps when called:

  1. If max = 0, return c(x).
  2. Let d be a new MatcherContinuation with parameters (y) that captures m, min, max, greedy, x, c, parenIndex, and parenCount and performs the following steps when called:
    1. Assert: y is a MatchState.
    2. If min = 0 and y.[[EndIndex]] = x.[[EndIndex]], return failure.
    3. If min = 0, let min2 be 0; otherwise let min2 be min - 1.
    4. If max = +∞, let max2 be +∞; otherwise let max2 be max - 1.
    5. Return RepeatMatcher(m, min2, max2, greedy, y, c, parenIndex, parenCount).
  3. Let cap be a copy of x.[[Captures]].
  4. For each integer k in the inclusive interval from parenIndex + 1 to parenIndex + parenCount, set cap[k] to undefined.
  5. Let Input be x.[[Input]].
  6. Let e be x.[[EndIndex]].
  7. Let xr be the MatchState { [[Input]]: Input, [[EndIndex]]: e, [[Captures]]: cap }.
  8. If min ≠ 0, return m(xr, d).
  9. If greedy is false, then
    1. Let z be c(x).
    2. If z is not failure, return z.
    3. Return m(xr, d).
  10. Let z be m(xr, d).
  11. If z is not failure, return z.
  12. Return c(x).
Note 1

An Atom followed by a Quantifier is repeated the number of times specified by the Quantifier. A Quantifier can be non-greedy, in which case the Atom pattern is repeated as few times as possible while still matching the sequel, or it can be greedy, in which case the Atom pattern is repeated as many times as possible while still matching the sequel. The Atom pattern is repeated rather than the input character sequence that it matches, so different repetitions of the Atom can match different input substrings.

Note 2

If the Atom and the sequel of the regular expression all have choice points, the Atom is first matched as many (or as few, if non-greedy) times as possible. All choices in the sequel are tried before moving on to the next choice in the last repetition of Atom. All choices in the last (nth) repetition of Atom are tried before moving on to the next choice in the next-to-last (n - 1)st repetition of Atom; at which point it may turn out that more or fewer repetitions of Atom are now possible; these are exhausted (again, starting with either as few or as many as possible) before moving on to the next choice in the (n - 1)st repetition of Atom and so on.

Compare

/a[a-z]{2,4}/.exec("abcdefghi")

which returns "abcde" with

/a[a-z]{2,4}?/.exec("abcdefghi")

which returns "abc".

Consider also

/(aa|aabaac|ba|b|c)*/.exec("aabaac")

which, by the choice point ordering above, returns the array

["aaba", "ba"]

and not any of:

["aabaac", "aabaac"]
["aabaac", "c"]

The above ordering of choice points can be used to write a regular expression that calculates the greatest common divisor of two numbers (represented in unary notation). The following example calculates the gcd of 10 and 15:

"aaaaaaaaaa,aaaaaaaaaaaaaaa".replace(/^(a+)\1*,\1+$/, "$1")

which returns the gcd in unary notation "aaaaa".

Note 3

Step 4 of the RepeatMatcher clears Atom's captures each time Atom is repeated. We can see its behaviour in the regular expression

/(z)((a+)?(b+)?(c))*/.exec("zaacbbbcac")

which returns the array

["zaacbbbcac", "z", "ac", "a", undefined, "c"]

and not

["zaacbbbcac", "z", "ac", "a", "bbb", "c"]

because each iteration of the outermost * clears all captured Strings contained in the quantified Atom, which in this case includes capture Strings numbered 2, 3, 4, and 5.

Note 4

Step 2.b of the RepeatMatcher states that once the minimum number of repetitions has been satisfied, any more expansions of Atom that match the empty character sequence are not considered for further repetitions. This prevents the regular expression engine from falling into an infinite loop on patterns such as:

/(a*)*/.exec("b")

or the slightly more complicated:

/(a*)b\1+/.exec("baaaac")

which returns the array

["b", ""]

22.2.2.3.2 EmptyMatcher ( )

The abstract operation EmptyMatcher takes no arguments and returns a Matcher. It performs the following steps when called:

  1. Return a new Matcher with parameters (x, c) that captures nothing and performs the following steps when called:
    1. Assert: x is a MatchState.
    2. Assert: c is a MatcherContinuation.
    3. Return c(x).

22.2.2.3.3 MatchTwoAlternatives ( m1, m2 )

The abstract operation MatchTwoAlternatives takes arguments m1 (a Matcher) and m2 (a Matcher) and returns a Matcher. It performs the following steps when called:

  1. Return a new Matcher with parameters (x, c) that captures m1 and m2 and performs the following steps when called:
    1. Assert: x is a MatchState.
    2. Assert: c is a MatcherContinuation.
    3. Let r be m1(x, c).
    4. If r is not failure, return r.
    5. Return m2(x, c).

22.2.2.3.4 MatchSequence ( m1, m2, direction )

The abstract operation MatchSequence takes arguments m1 (a Matcher), m2 (a Matcher), and direction (forward or backward) and returns a Matcher. It performs the following steps when called:

  1. If direction is forward, then
    1. Return a new Matcher with parameters (x, c) that captures m1 and m2 and performs the following steps when called:
      1. Assert: x is a MatchState.
      2. Assert: c is a MatcherContinuation.
      3. Let d be a new MatcherContinuation with parameters (y) that captures c and m2 and performs the following steps when called:
        1. Assert: y is a MatchState.
        2. Return m2(y, c).
      4. Return m1(x, d).
  2. Else,
    1. Assert: direction is backward.
    2. Return a new Matcher with parameters (x, c) that captures m1 and m2 and performs the following steps when called:
      1. Assert: x is a MatchState.
      2. Assert: c is a MatcherContinuation.
      3. Let d be a new MatcherContinuation with parameters (y) that captures c and m1 and performs the following steps when called:
        1. Assert: y is a MatchState.
        2. Return m1(y, c).
      4. Return m2(x, d).

22.2.2.4 Runtime Semantics: CompileAssertion

The syntax-directed operation CompileAssertion takes argument rer (a RegExp Record) and returns a Matcher.

Note 1

This section is amended in B.1.2.6.

It is defined piecewise over the following productions:

Assertion :: ^
  1. Return a new Matcher with parameters (x, c) that captures rer and performs the following steps when called:
    1. Assert: x is a MatchState.
    2. Assert: c is a MatcherContinuation.
    3. Let Input be x.[[Input]].
    4. Let e be x.[[EndIndex]].
    5. If e = 0, or if rer.[[Multiline]] is true and the character Input[e - 1] is matched by LineTerminator, then
      1. Return c(x).
    6. Return failure.
Note 2

Even when the y flag is used with a pattern, ^ always matches only at the beginning of Input, or (if rer.[[Multiline]] is true) at the beginning of a line.

Assertion :: $
  1. Return a new Matcher with parameters (x, c) that captures rer and performs the following steps when called:
    1. Assert: x is a MatchState.
    2. Assert: c is a MatcherContinuation.
    3. Let Input be x.[[Input]].
    4. Let e be x.[[EndIndex]].
    5. Let InputLength be the number of elements in Input.
    6. If e = InputLength, or if rer.[[Multiline]] is true and the character Input[e] is matched by LineTerminator, then
      1. Return c(x).
    7. Return failure.
Assertion :: \b
  1. Return a new Matcher with parameters (x, c) that captures rer and performs the following steps when called:
    1. Assert: x is a MatchState.
    2. Assert: c is a MatcherContinuation.
    3. Let Input be x.[[Input]].
    4. Let e be x.[[EndIndex]].
    5. Let a be IsWordChar(rer, Input, e - 1).
    6. Let b be IsWordChar(rer, Input, e).
    7. If a is true and b is false, or if a is false and b is true, return c(x).
    8. Return failure.
Assertion :: \B
  1. Return a new Matcher with parameters (x, c) that captures rer and performs the following steps when called:
    1. Assert: x is a MatchState.
    2. Assert: c is a MatcherContinuation.
    3. Let Input be x.[[Input]].
    4. Let e be x.[[EndIndex]].
    5. Let a be IsWordChar(rer, Input, e - 1).
    6. Let b be IsWordChar(rer, Input, e).
    7. If a is true and b is true, or if a is false and b is false, return c(x).
    8. Return failure.
Assertion :: (?= Disjunction )
  1. Let m be CompileSubpattern of Disjunction with arguments rer and forward.
  2. Return a new Matcher with parameters (x, c) that captures m and performs the following steps when called:
    1. Assert: x is a MatchState.
    2. Assert: c is a MatcherContinuation.
    3. Let d be a new MatcherContinuation with parameters (y) that captures nothing and performs the following steps when called:
      1. Assert: y is a MatchState.
      2. Return y.
    4. Let r be m(x, d).
    5. If r is failure, return failure.
    6. Assert: r is a MatchState.
    7. Let cap be r.[[Captures]].
    8. Let Input be x.[[Input]].
    9. Let xe be x.[[EndIndex]].
    10. Let z be the MatchState { [[Input]]: Input, [[EndIndex]]: xe, [[Captures]]: cap }.
    11. Return c(z).
Note 3

The form (?= Disjunction ) specifies a zero-width positive lookahead. In order for it to succeed, the pattern inside Disjunction must match at the current position, but the current position is not advanced before matching the sequel. If Disjunction can match at the current position in several ways, only the first one is tried. Unlike other regular expression operators, there is no backtracking into a (?= form (this unusual behaviour is inherited from Perl). This only matters when the Disjunction contains capturing parentheses and the sequel of the pattern contains backreferences to those captures.

For example,

/(?=(a+))/.exec("baaabac")

matches the empty String immediately after the first b and therefore returns the array:

["", "aaa"]

To illustrate the lack of backtracking into the lookahead, consider:

/(?=(a+))a*b\1/.exec("baaabac")

This expression returns

["aba", "a"]

and not:

["aaaba", "a"]
Assertion :: (?! Disjunction )
  1. Let m be CompileSubpattern of Disjunction with arguments rer and forward.
  2. Return a new Matcher with parameters (x, c) that captures m and performs the following steps when called:
    1. Assert: x is a MatchState.
    2. Assert: c is a MatcherContinuation.
    3. Let d be a new MatcherContinuation with parameters (y) that captures nothing and performs the following steps when called:
      1. Assert: y is a MatchState.
      2. Return y.
    4. Let r be m(x, d).
    5. If r is not failure, return failure.
    6. Return c(x).
Note 4

The form (?! Disjunction ) specifies a zero-width negative lookahead. In order for it to succeed, the pattern inside Disjunction must fail to match at the current position. The current position is not advanced before matching the sequel. Disjunction can contain capturing parentheses, but backreferences to them only make sense from within Disjunction itself. Backreferences to these capturing parentheses from elsewhere in the pattern always return undefined because the negative lookahead must fail for the pattern to succeed. For example,

/(.*?)a(?!(a+)b\2c)\2(.*)/.exec("baaabaac")

looks for an a not immediately followed by some positive number n of a's, a b, another n a's (specified by the first \2) and a c. The second \2 is outside the negative lookahead, so it matches against undefined and therefore always succeeds. The whole expression returns the array:

["baaabaac", "ba", undefined, "abaac"]
Assertion :: (?<= Disjunction )
  1. Let m be CompileSubpattern of Disjunction with arguments rer and backward.
  2. Return a new Matcher with parameters (x, c) that captures m and performs the following steps when called:
    1. Assert: x is a MatchState.
    2. Assert: c is a MatcherContinuation.
    3. Let d be a new MatcherContinuation with parameters (y) that captures nothing and performs the following steps when called:
      1. Assert: y is a MatchState.
      2. Return y.
    4. Let r be m(x, d).
    5. If r is failure, return failure.
    6. Assert: r is a MatchState.
    7. Let cap be r.[[Captures]].
    8. Let Input be x.[[Input]].
    9. Let xe be x.[[EndIndex]].
    10. Let z be the MatchState { [[Input]]: Input, [[EndIndex]]: xe, [[Captures]]: cap }.
    11. Return c(z).
Assertion :: (?<! Disjunction )
  1. Let m be CompileSubpattern of Disjunction with arguments rer and backward.
  2. Return a new Matcher with parameters (x, c) that captures m and performs the following steps when called:
    1. Assert: x is a MatchState.
    2. Assert: c is a MatcherContinuation.
    3. Let d be a new MatcherContinuation with parameters (y) that captures nothing and performs the following steps when called:
      1. Assert: y is a MatchState.
      2. Return y.
    4. Let r be m(x, d).
    5. If r is not failure, return failure.
    6. Return c(x).

22.2.2.4.1 IsWordChar ( rer, Input, e )

The abstract operation IsWordChar takes arguments rer (a RegExp Record), Input (a List of characters), and e (an integer) and returns a Boolean. It performs the following steps when called:

  1. Let InputLength be the number of elements in Input.
  2. If e = -1 or e = InputLength, return false.
  3. Let c be the character Input[e].
  4. If WordCharacters(rer) contains c, return true.
  5. Return false.

22.2.2.5 Runtime Semantics: CompileQuantifier

The syntax-directed operation CompileQuantifier takes no arguments and returns a Record with fields [[Min]] (a non-negative integer), [[Max]] (a non-negative integer or +∞), and [[Greedy]] (a Boolean). It is defined piecewise over the following productions:

Quantifier :: QuantifierPrefix
  1. Let qp be CompileQuantifierPrefix of QuantifierPrefix.
  2. Return the Record { [[Min]]: qp.[[Min]], [[Max]]: qp.[[Max]], [[Greedy]]: true }.
Quantifier :: QuantifierPrefix ?
  1. Let qp be CompileQuantifierPrefix of QuantifierPrefix.
  2. Return the Record { [[Min]]: qp.[[Min]], [[Max]]: qp.[[Max]], [[Greedy]]: false }.

22.2.2.6 Runtime Semantics: CompileQuantifierPrefix

The syntax-directed operation CompileQuantifierPrefix takes no arguments and returns a Record with fields [[Min]] (a non-negative integer) and [[Max]] (a non-negative integer or +∞). It is defined piecewise over the following productions:

QuantifierPrefix :: *
  1. Return the Record { [[Min]]: 0, [[Max]]: +∞ }.
QuantifierPrefix :: +
  1. Return the Record { [[Min]]: 1, [[Max]]: +∞ }.
QuantifierPrefix :: ?
  1. Return the Record { [[Min]]: 0, [[Max]]: 1 }.
QuantifierPrefix :: { DecimalDigits }
  1. Let i be the MV of DecimalDigits (see 12.9.3).
  2. Return the Record { [[Min]]: i, [[Max]]: i }.
QuantifierPrefix :: { DecimalDigits ,}
  1. Let i be the MV of DecimalDigits.
  2. Return the Record { [[Min]]: i, [[Max]]: +∞ }.
QuantifierPrefix :: { DecimalDigits , DecimalDigits }
  1. Let i be the MV of the first DecimalDigits.
  2. Let j be the MV of the second DecimalDigits.
  3. Return the Record { [[Min]]: i, [[Max]]: j }.

22.2.2.7 Runtime Semantics: CompileAtom

The syntax-directed operation CompileAtom takes arguments rer (a RegExp Record) and direction (forward or backward) and returns a Matcher.

Note 1

This section is amended in B.1.2.7.

It is defined piecewise over the following productions:

Atom :: PatternCharacter
  1. Let ch be the character matched by PatternCharacter.
  2. Let A be a one-element CharSet containing the character ch.
  3. Return CharacterSetMatcher(rer, A, false, direction).
Atom :: .
  1. Let A be AllCharacters(rer).
  2. If rer.[[DotAll]] is not true, then
    1. Remove from A all characters corresponding to a code point on the right-hand side of the LineTerminator production.
  3. Return CharacterSetMatcher(rer, A, false, direction).
Atom :: CharacterClass
  1. Let cc be CompileCharacterClass of CharacterClass with argument rer.
  2. Let cs be cc.[[CharSet]].
  3. If rer.[[UnicodeSets]] is false, or if every CharSetElement of cs consists of a single character (including if cs is empty), return CharacterSetMatcher(rer, cs, cc.[[Invert]], direction).
  4. Assert: cc.[[Invert]] is false.
  5. Let lm be an empty List of Matchers.
  6. For each CharSetElement s in cs containing more than 1 character, iterating in descending order of length, do
    1. Let cs2 be a one-element CharSet containing the last code point of s.
    2. Let m2 be CharacterSetMatcher(rer, cs2, false, direction).
    3. For each code point c1 in s, iterating backwards from its second-to-last code point, do
      1. Let cs1 be a one-element CharSet containing c1.
      2. Let m1 be CharacterSetMatcher(rer, cs1, false, direction).
      3. Set m2 to MatchSequence(m1, m2, direction).
    4. Append m2 to lm.
  7. Let singles be the CharSet containing every CharSetElement of cs that consists of a single character.
  8. Append CharacterSetMatcher(rer, singles, false, direction) to lm.
  9. If cs contains the empty sequence of characters, append EmptyMatcher() to lm.
  10. Let m2 be the last Matcher in lm.
  11. For each Matcher m1 of lm, iterating backwards from its second-to-last element, do
    1. Set m2 to MatchTwoAlternatives(m1, m2).
  12. Return m2.
Atom :: ( GroupSpecifieropt Disjunction )
  1. Let m be CompileSubpattern of Disjunction with arguments rer and direction.
  2. Let parenIndex be CountLeftCapturingParensBefore(Atom).
  3. Return a new Matcher with parameters (x, c) that captures direction, m, and parenIndex and performs the following steps when called:
    1. Assert: x is a MatchState.
    2. Assert: c is a MatcherContinuation.
    3. Let d be a new MatcherContinuation with parameters (y) that captures x, c, direction, and parenIndex and performs the following steps when called:
      1. Assert: y is a MatchState.
      2. Let cap be a copy of y.[[Captures]].
      3. Let Input be x.[[Input]].
      4. Let xe be x.[[EndIndex]].
      5. Let ye be y.[[EndIndex]].
      6. If direction is forward, then
        1. Assert: xeye.
        2. Let r be the CaptureRange { [[StartIndex]]: xe, [[EndIndex]]: ye }.
      7. Else,
        1. Assert: direction is backward.
        2. Assert: yexe.
        3. Let r be the CaptureRange { [[StartIndex]]: ye, [[EndIndex]]: xe }.
      8. Set cap[parenIndex + 1] to r.
      9. Let z be the MatchState { [[Input]]: Input, [[EndIndex]]: ye, [[Captures]]: cap }.
      10. Return c(z).
    4. Return m(x, d).
Note 2

Parentheses of the form ( Disjunction ) serve both to group the components of the Disjunction pattern together and to save the result of the match. The result can be used either in a backreference (\ followed by a non-zero decimal number), referenced in a replace String, or returned as part of an array from the regular expression matching Abstract Closure. To inhibit the capturing behaviour of parentheses, use the form (?: Disjunction ) instead.

Atom :: (? RegularExpressionModifiers : Disjunction )
  1. Let addModifiers be the source text matched by RegularExpressionModifiers.
  2. Let removeModifiers be the empty String.
  3. Let modifiedRer be UpdateModifiers(rer, CodePointsToString(addModifiers), removeModifiers).
  4. Return CompileSubpattern of Disjunction with arguments modifiedRer and direction.
Atom :: (? RegularExpressionModifiers - RegularExpressionModifiers : Disjunction )
  1. Let addModifiers be the source text matched by the first RegularExpressionModifiers.
  2. Let removeModifiers be the source text matched by the second RegularExpressionModifiers.
  3. Let modifiedRer be UpdateModifiers(rer, CodePointsToString(addModifiers), CodePointsToString(removeModifiers)).
  4. Return CompileSubpattern of Disjunction with arguments modifiedRer and direction.
AtomEscape :: DecimalEscape
  1. Let n be the CapturingGroupNumber of DecimalEscape.
  2. Assert: nrer.[[CapturingGroupsCount]].
  3. Return BackreferenceMatcher(rer, « n », direction).
Note 3

An escape sequence of the form \ followed by a non-zero decimal number n matches the result of the nth set of capturing parentheses (22.2.2.1). It is an error if the regular expression has fewer than n capturing parentheses. If the regular expression has n or more capturing parentheses but the nth one is undefined because it has not captured anything, then the backreference always succeeds.

AtomEscape :: CharacterEscape
  1. Let cv be the CharacterValue of CharacterEscape.
  2. Let ch be the character whose character value is cv.
  3. Let A be a one-element CharSet containing the character ch.
  4. Return CharacterSetMatcher(rer, A, false, direction).
AtomEscape :: CharacterClassEscape
  1. Let cs be CompileToCharSet of CharacterClassEscape with argument rer.
  2. If rer.[[UnicodeSets]] is false, or if every CharSetElement of cs consists of a single character (including if cs is empty), return CharacterSetMatcher(rer, cs, false, direction).
  3. Let lm be an empty List of Matchers.
  4. For each CharSetElement s in cs containing more than 1 character, iterating in descending order of length, do
    1. Let cs2 be a one-element CharSet containing the last code point of s.
    2. Let m2 be CharacterSetMatcher(rer, cs2, false, direction).
    3. For each code point c1 in s, iterating backwards from its second-to-last code point, do
      1. Let cs1 be a one-element CharSet containing c1.
      2. Let m1 be CharacterSetMatcher(rer, cs1, false, direction).
      3. Set m2 to MatchSequence(m1, m2, direction).
    4. Append m2 to lm.
  5. Let singles be the CharSet containing every CharSetElement of cs that consists of a single character.
  6. Append CharacterSetMatcher(rer, singles, false, direction) to lm.
  7. If cs contains the empty sequence of characters, append EmptyMatcher() to lm.
  8. Let m2 be the last Matcher in lm.
  9. For each Matcher m1 of lm, iterating backwards from its second-to-last element, do
    1. Set m2 to MatchTwoAlternatives(m1, m2).
  10. Return m2.
AtomEscape :: k GroupName
  1. Let matchingGroupSpecifiers be GroupSpecifiersThatMatch(GroupName).
  2. Let parenIndices be a new empty List.
  3. For each GroupSpecifier groupSpecifier of matchingGroupSpecifiers, do
    1. Let parenIndex be CountLeftCapturingParensBefore(groupSpecifier).
    2. Append parenIndex to parenIndices.
  4. Return BackreferenceMatcher(rer, parenIndices, direction).

22.2.2.7.1 CharacterSetMatcher ( rer, A, invert, direction )

The abstract operation CharacterSetMatcher takes arguments rer (a RegExp Record), A (a CharSet), invert (a Boolean), and direction (forward or backward) and returns a Matcher. It performs the following steps when called:

  1. If rer.[[UnicodeSets]] is true, then
    1. Assert: invert is false.
    2. Assert: Every CharSetElement of A consists of a single character.
  2. Return a new Matcher with parameters (x, c) that captures rer, A, invert, and direction and performs the following steps when called:
    1. Assert: x is a MatchState.
    2. Assert: c is a MatcherContinuation.
    3. Let Input be x.[[Input]].
    4. Let e be x.[[EndIndex]].
    5. If direction is forward, let f be e + 1.
    6. Else, let f be e - 1.
    7. Let InputLength be the number of elements in Input.
    8. If f < 0 or f > InputLength, return failure.
    9. Let index be min(e, f).
    10. Let ch be the character Input[index].
    11. Let cc be Canonicalize(rer, ch).
    12. If there exists a CharSetElement in A containing exactly one character a such that Canonicalize(rer, a) is cc, let found be true; otherwise let found be false.
    13. If invert is false and found is false, return failure.
    14. If invert is true and found is true, return failure.
    15. Let cap be x.[[Captures]].
    16. Let y be the MatchState { [[Input]]: Input, [[EndIndex]]: f, [[Captures]]: cap }.
    17. Return c(y).

22.2.2.7.2 BackreferenceMatcher ( rer, ns, direction )

The abstract operation BackreferenceMatcher takes arguments rer (a RegExp Record), ns (a List of positive integers), and direction (forward or backward) and returns a Matcher. It performs the following steps when called:

  1. Return a new Matcher with parameters (x, c) that captures rer, ns, and direction and performs the following steps when called:
    1. Assert: x is a MatchState.
    2. Assert: c is a MatcherContinuation.
    3. Let Input be x.[[Input]].
    4. Let cap be x.[[Captures]].
    5. Let r be undefined.
    6. For each integer n of ns, do
      1. If cap[n] is not undefined, then
        1. Assert: r is undefined.
        2. Set r to cap[n].
    7. If r is undefined, return c(x).
    8. Let e be x.[[EndIndex]].
    9. Let rs be r.[[StartIndex]].
    10. Let re be r.[[EndIndex]].
    11. Let len be re - rs.
    12. If direction is forward, let f be e + len.
    13. Else, let f be e - len.
    14. Let InputLength be the number of elements in Input.
    15. If f < 0 or f > InputLength, return failure.
    16. Let g be min(e, f).
    17. If there exists an integer i in the interval from 0 (inclusive) to len (exclusive) such that Canonicalize(rer, Input[rs + i]) is not Canonicalize(rer, Input[g + i]), return failure.
    18. Let y be the MatchState { [[Input]]: Input, [[EndIndex]]: f, [[Captures]]: cap }.
    19. Return c(y).

22.2.2.7.3 Canonicalize ( rer, ch )

The abstract operation Canonicalize takes arguments rer (a RegExp Record) and ch (a character) and returns a character. It performs the following steps when called:

  1. If HasEitherUnicodeFlag(rer) is true and rer.[[IgnoreCase]] is true, then
    1. If the file CaseFolding.txt of the Unicode Character Database provides a simple or common case folding mapping for ch, return the result of applying that mapping to ch.
    2. Return ch.
  2. If rer.[[IgnoreCase]] is false, return ch.
  3. Assert: ch is a UTF-16 code unit.
  4. Let cp be the code point whose numeric value is the numeric value of ch.
  5. Let u be toUppercase(« cp »), according to the Unicode Default Case Conversion algorithm.
  6. Let uStr be CodePointsToString(u).
  7. If the length of uStr ≠ 1, return ch.
  8. Let cu be uStr's single code unit element.
  9. If the numeric value of ch ≥ 128 and the numeric value of cu < 128, return ch.
  10. Return cu.
Note

In case-insignificant matches when HasEitherUnicodeFlag(rer) is true, all characters are implicitly case-folded using the simple mapping provided by the Unicode Standard immediately before they are compared. The simple mapping always maps to a single code point, so it does not map, for example, ß (U+00DF LATIN SMALL LETTER SHARP S) to ss or SS. It may however map code points outside the Basic Latin block to code points within it—for example, ſ (U+017F LATIN SMALL LETTER LONG S) case-folds to s (U+0073 LATIN SMALL LETTER S) and (U+212A KELVIN SIGN) case-folds to k (U+006B LATIN SMALL LETTER K). Strings containing those code points are matched by regular expressions such as /[a-z]/ui.

In case-insignificant matches when HasEitherUnicodeFlag(rer) is false, the mapping is based on Unicode Default Case Conversion algorithm toUppercase rather than toCasefold, which results in some subtle differences. For example, (U+2126 OHM SIGN) is mapped by toUppercase to itself but by toCasefold to ω (U+03C9 GREEK SMALL LETTER OMEGA) along with Ω (U+03A9 GREEK CAPITAL LETTER OMEGA), so "\u2126" is matched by /[ω]/ui and /[\u03A9]/ui but not by /[ω]/i or /[\u03A9]/i. Also, no code point outside the Basic Latin block is mapped to a code point within it, so strings such as "\u017F ſ" and "\u212A K" are not matched by /[a-z]/i.

22.2.2.7.4 UpdateModifiers ( rer, add, remove )

The abstract operation UpdateModifiers takes arguments rer (a RegExp Record), add (a String), and remove (a String) and returns a RegExp Record. It performs the following steps when called:

  1. Assert: add and remove have no elements in common.
  2. Let ignoreCase be rer.[[IgnoreCase]].
  3. Let multiline be rer.[[Multiline]].
  4. Let dotAll be rer.[[DotAll]].
  5. Let unicode be rer.[[Unicode]].
  6. Let unicodeSets be rer.[[UnicodeSets]].
  7. Let capturingGroupsCount be rer.[[CapturingGroupsCount]].
  8. If remove contains "i", set ignoreCase to false.
  9. Else if add contains "i", set ignoreCase to true.
  10. If remove contains "m", set multiline to false.
  11. Else if add contains "m", set multiline to true.
  12. If remove contains "s", set dotAll to false.
  13. Else if add contains "s", set dotAll to true.
  14. Return the RegExp Record { [[IgnoreCase]]: ignoreCase, [[Multiline]]: multiline, [[DotAll]]: dotAll, [[Unicode]]: unicode, [[UnicodeSets]]: unicodeSets, [[CapturingGroupsCount]]: capturingGroupsCount }.

22.2.2.8 Runtime Semantics: CompileCharacterClass

The syntax-directed operation CompileCharacterClass takes argument rer (a RegExp Record) and returns a Record with fields [[CharSet]] (a CharSet) and [[Invert]] (a Boolean). It is defined piecewise over the following productions:

CharacterClass :: [ ClassContents ]
  1. Let A be CompileToCharSet of ClassContents with argument rer.
  2. Return the Record { [[CharSet]]: A, [[Invert]]: false }.
CharacterClass :: [^ ClassContents ]
  1. Let A be CompileToCharSet of ClassContents with argument rer.
  2. If rer.[[UnicodeSets]] is true, then
    1. Return the Record { [[CharSet]]: CharacterComplement(rer, A), [[Invert]]: false }.
  3. Return the Record { [[CharSet]]: A, [[Invert]]: true }.

22.2.2.9 Runtime Semantics: CompileToCharSet

The syntax-directed operation CompileToCharSet takes argument rer (a RegExp Record) and returns a CharSet.

Note 1

This section is amended in B.1.2.8.

It is defined piecewise over the following productions:

ClassContents :: [empty]
  1. Return the empty CharSet.
NonemptyClassRanges :: ClassAtom NonemptyClassRangesNoDash
  1. Let A be CompileToCharSet of ClassAtom with argument rer.
  2. Let B be CompileToCharSet of NonemptyClassRangesNoDash with argument rer.
  3. Return the union of CharSets A and B.
NonemptyClassRanges :: ClassAtom - ClassAtom ClassContents
  1. Let A be CompileToCharSet of the first ClassAtom with argument rer.
  2. Let B be CompileToCharSet of the second ClassAtom with argument rer.
  3. Let C be CompileToCharSet of ClassContents with argument rer.
  4. Let D be CharacterRange(A, B).
  5. Return the union of D and C.
NonemptyClassRangesNoDash :: ClassAtomNoDash NonemptyClassRangesNoDash
  1. Let A be CompileToCharSet of ClassAtomNoDash with argument rer.
  2. Let B be CompileToCharSet of NonemptyClassRangesNoDash with argument rer.
  3. Return the union of CharSets A and B.
NonemptyClassRangesNoDash :: ClassAtomNoDash - ClassAtom ClassContents
  1. Let A be CompileToCharSet of ClassAtomNoDash with argument rer.
  2. Let B be CompileToCharSet of ClassAtom with argument rer.
  3. Let C be CompileToCharSet of ClassContents with argument rer.
  4. Let D be CharacterRange(A, B).
  5. Return the union of D and C.
Note 2

ClassContents can expand into a single ClassAtom and/or ranges of two ClassAtom separated by dashes. In the latter case the ClassContents includes all characters between the first ClassAtom and the second ClassAtom, inclusive; an error occurs if either ClassAtom does not represent a single character (for example, if one is \w) or if the first ClassAtom's character value is strictly greater than the second ClassAtom's character value.

Note 3

Even if the pattern ignores case, the case of the two ends of a range is significant in determining which characters belong to the range. Thus, for example, the pattern /[E-F]/i matches only the letters E, F, e, and f, while the pattern /[E-f]/i matches all uppercase and lowercase letters in the Unicode Basic Latin block as well as the symbols [, \, ], ^, _, and `.

Note 4

A - character can be treated literally or it can denote a range. It is treated literally if it is the first or last character of ClassContents, the beginning or end limit of a range specification, or immediately follows a range specification.

ClassAtom :: -
  1. Return the CharSet containing the single character - U+002D (HYPHEN-MINUS).
ClassAtomNoDash :: SourceCharacter but not one of \ or ] or -
  1. Return the CharSet containing the character matched by SourceCharacter.
ClassEscape :: b - CharacterEscape
  1. Let cv be the CharacterValue of this ClassEscape.
  2. Let c be the character whose character value is cv.
  3. Return the CharSet containing the single character c.
Note 5

A ClassAtom can use any of the escape sequences that are allowed in the rest of the regular expression except for \b, \B, and backreferences. Inside a CharacterClass, \b means the backspace character, while \B and backreferences raise errors. Using a backreference inside a ClassAtom causes an error.

CharacterClassEscape :: d
  1. Return the ten-element CharSet containing the characters 0, 1, 2, 3, 4, 5, 6, 7, 8, and 9.
CharacterClassEscape :: D
  1. Let S be the CharSet returned by CharacterClassEscape :: d .
  2. Return CharacterComplement(rer, S).
CharacterClassEscape :: s
  1. Return the CharSet containing all characters corresponding to a code point on the right-hand side of the WhiteSpace or LineTerminator productions.
CharacterClassEscape :: S
  1. Let S be the CharSet returned by CharacterClassEscape :: s .
  2. Return CharacterComplement(rer, S).
CharacterClassEscape :: w
  1. Return MaybeSimpleCaseFolding(rer, WordCharacters(rer)).
CharacterClassEscape :: W
  1. Let S be the CharSet returned by CharacterClassEscape :: w .
  2. Return CharacterComplement(rer, S).
CharacterClassEscape :: p{ UnicodePropertyValueExpression }
  1. Return CompileToCharSet of UnicodePropertyValueExpression with argument rer.
CharacterClassEscape :: P{ UnicodePropertyValueExpression }
  1. Let S be CompileToCharSet of UnicodePropertyValueExpression with argument rer.
  2. Assert: S contains only single code points.
  3. Return CharacterComplement(rer, S).
UnicodePropertyValueExpression :: UnicodePropertyName = UnicodePropertyValue
  1. Let ps be the source text matched by UnicodePropertyName.
  2. Let p be UnicodeMatchProperty(rer, ps).
  3. Assert: p is a Unicode property name or property alias listed in the “Property name and aliases” column of Table 69.
  4. Let vs be the source text matched by UnicodePropertyValue.
  5. Let v be UnicodeMatchPropertyValue(p, vs).
  6. Let A be the CharSet containing all Unicode code points whose character database definition includes the property p with value v.
  7. Return MaybeSimpleCaseFolding(rer, A).
UnicodePropertyValueExpression :: LoneUnicodePropertyNameOrValue
  1. Let s be the source text matched by LoneUnicodePropertyNameOrValue.
  2. If UnicodeMatchPropertyValue(General_Category, s) is a Unicode property value or property value alias for the General_Category (gc) property listed in PropertyValueAliases.txt, then
    1. Return the CharSet containing all Unicode code points whose character database definition includes the property “General_Category” with value s.
  3. Let p be UnicodeMatchProperty(rer, s).
  4. Assert: p is a binary Unicode property or binary property alias listed in the “Property name and aliases” column of Table 70, or a binary Unicode property of strings listed in the “Property name” column of Table 71.
  5. Let A be the CharSet containing all CharSetElements whose character database definition includes the property p with value “True”.
  6. Return MaybeSimpleCaseFolding(rer, A).
ClassUnion :: ClassSetRange ClassUnionopt
  1. Let A be CompileToCharSet of ClassSetRange with argument rer.
  2. If ClassUnion is present, then
    1. Let B be CompileToCharSet of ClassUnion with argument rer.
    2. Return the union of CharSets A and B.
  3. Return A.
ClassUnion :: ClassSetOperand ClassUnionopt
  1. Let A be CompileToCharSet of ClassSetOperand with argument rer.
  2. If ClassUnion is present, then
    1. Let B be CompileToCharSet of ClassUnion with argument rer.
    2. Return the union of CharSets A and B.
  3. Return A.
ClassIntersection :: ClassSetOperand && ClassSetOperand
  1. Let A be CompileToCharSet of the first ClassSetOperand with argument rer.
  2. Let B be CompileToCharSet of the second ClassSetOperand with argument rer.
  3. Return the intersection of CharSets A and B.
ClassIntersection :: ClassIntersection && ClassSetOperand
  1. Let A be CompileToCharSet of the ClassIntersection with argument rer.
  2. Let B be CompileToCharSet of the ClassSetOperand with argument rer.
  3. Return the intersection of CharSets A and B.
ClassSubtraction :: ClassSetOperand -- ClassSetOperand
  1. Let A be CompileToCharSet of the first ClassSetOperand with argument rer.
  2. Let B be CompileToCharSet of the second ClassSetOperand with argument rer.
  3. Return the CharSet containing the CharSetElements of A which are not also CharSetElements of B.
ClassSubtraction :: ClassSubtraction -- ClassSetOperand
  1. Let A be CompileToCharSet of the ClassSubtraction with argument rer.
  2. Let B be CompileToCharSet of the ClassSetOperand with argument rer.
  3. Return the CharSet containing the CharSetElements of A which are not also CharSetElements of B.
ClassSetRange :: ClassSetCharacter - ClassSetCharacter
  1. Let A be CompileToCharSet of the first ClassSetCharacter with argument rer.
  2. Let B be CompileToCharSet of the second ClassSetCharacter with argument rer.
  3. Return MaybeSimpleCaseFolding(rer, CharacterRange(A, B)).
Note 6

The result will often consist of two or more ranges. When UnicodeSets is true and IgnoreCase is true, then MaybeSimpleCaseFolding(rer, [Ā-č]) will include only the odd-numbered code points of that range.

ClassSetOperand :: ClassSetCharacter
  1. Let A be CompileToCharSet of ClassSetCharacter with argument rer.
  2. Return MaybeSimpleCaseFolding(rer, A).
ClassSetOperand :: ClassStringDisjunction
  1. Let A be CompileToCharSet of ClassStringDisjunction with argument rer.
  2. Return MaybeSimpleCaseFolding(rer, A).
ClassSetOperand :: NestedClass
  1. Return CompileToCharSet of NestedClass with argument rer.
NestedClass :: [ ClassContents ]
  1. Return CompileToCharSet of ClassContents with argument rer.
NestedClass :: [^ ClassContents ]
  1. Let A be CompileToCharSet of ClassContents with argument rer.
  2. Return CharacterComplement(rer, A).
NestedClass :: \ CharacterClassEscape
  1. Return CompileToCharSet of CharacterClassEscape with argument rer.
ClassStringDisjunction :: \q{ ClassStringDisjunctionContents }
  1. Return CompileToCharSet of ClassStringDisjunctionContents with argument rer.
ClassStringDisjunctionContents :: ClassString
  1. Let s be CompileClassSetString of ClassString with argument rer.
  2. Return the CharSet containing the one string s.
ClassStringDisjunctionContents :: ClassString | ClassStringDisjunctionContents
  1. Let s be CompileClassSetString of ClassString with argument rer.
  2. Let A be the CharSet containing the one string s.
  3. Let B be CompileToCharSet of ClassStringDisjunctionContents with argument rer.
  4. Return the union of CharSets A and B.
ClassSetCharacter :: SourceCharacter but not ClassSetSyntaxCharacter \ CharacterEscape \ ClassSetReservedPunctuator
  1. Let cv be the CharacterValue of this ClassSetCharacter.
  2. Let c be the character whose character value is cv.
  3. Return the CharSet containing the single character c.
ClassSetCharacter :: \b
  1. Return the CharSet containing the single character U+0008 (BACKSPACE).

22.2.2.9.1 CharacterRange ( A, B )

The abstract operation CharacterRange takes arguments A (a CharSet) and B (a CharSet) and returns a CharSet. It performs the following steps when called:

  1. Assert: A and B each contain exactly one character.
  2. Let a be the one character in CharSet A.
  3. Let b be the one character in CharSet B.
  4. Let i be the character value of character a.
  5. Let j be the character value of character b.
  6. Assert: ij.
  7. Return the CharSet containing all characters with a character value in the inclusive interval from i to j.

22.2.2.9.2 HasEitherUnicodeFlag ( rer )

The abstract operation HasEitherUnicodeFlag takes argument rer (a RegExp Record) and returns a Boolean. It performs the following steps when called:

  1. If rer.[[Unicode]] is true or rer.[[UnicodeSets]] is true, then
    1. Return true.
  2. Return false.

22.2.2.9.3 WordCharacters ( rer )

The abstract operation WordCharacters takes argument rer (a RegExp Record) and returns a CharSet. Returns a CharSet containing the characters considered "word characters" for the purposes of \b, \B, \w, and \W It performs the following steps when called:

  1. Let basicWordChars be the CharSet containing every character in the ASCII word characters.
  2. Let extraWordChars be the CharSet containing all characters c such that c is not in basicWordChars but Canonicalize(rer, c) is in basicWordChars.
  3. Assert: extraWordChars is empty unless HasEitherUnicodeFlag(rer) is true and rer.[[IgnoreCase]] is true.
  4. Return the union of basicWordChars and extraWordChars.

22.2.2.9.4 AllCharacters ( rer )

The abstract operation AllCharacters takes argument rer (a RegExp Record) and returns a CharSet. Returns the set of “all characters” according to the regular expression flags. It performs the following steps when called:

  1. If rer.[[UnicodeSets]] is true and rer.[[IgnoreCase]] is true, then
    1. Return the CharSet containing all Unicode code points c that do not have a Simple Case Folding mapping (that is, scf(c)=c).
  2. Else if HasEitherUnicodeFlag(rer) is true, then
    1. Return the CharSet containing all code point values.
  3. Else,
    1. Return the CharSet containing all code unit values.

22.2.2.9.5 MaybeSimpleCaseFolding ( rer, A )

The abstract operation MaybeSimpleCaseFolding takes arguments rer (a RegExp Record) and A (a CharSet) and returns a CharSet. If rer.[[UnicodeSets]] is false or rer.[[IgnoreCase]] is false, it returns A. Otherwise, it uses the Simple Case Folding (scf(cp)) definitions in the file CaseFolding.txt of the Unicode Character Database (each of which maps a single code point to another single code point) to map each CharSetElement of A character-by-character into a canonical form and returns the resulting CharSet. It performs the following steps when called:

  1. If rer.[[UnicodeSets]] is false or rer.[[IgnoreCase]] is false, return A.
  2. Let B be a new empty CharSet.
  3. For each CharSetElement s of A, do
    1. Let t be an empty sequence of characters.
    2. For each single code point cp in s, do
      1. Append scf(cp) to t.
    3. Add t to B.
  4. Return B.

22.2.2.9.6 CharacterComplement ( rer, S )

The abstract operation CharacterComplement takes arguments rer (a RegExp Record) and S (a CharSet) and returns a CharSet. It performs the following steps when called:

  1. Let A be AllCharacters(rer).
  2. Return the CharSet containing the CharSetElements of A which are not also CharSetElements of S.

22.2.2.9.7 UnicodeMatchProperty ( rer, p )

The abstract operation UnicodeMatchProperty takes arguments rer (a RegExp Record) and p (ECMAScript source text) and returns a Unicode property name. It performs the following steps when called:

  1. If rer.[[UnicodeSets]] is true and p is a Unicode property name listed in the “Property name” column of Table 71, then
    1. Return the List of Unicode code points p.
  2. Assert: p is a Unicode property name or property alias listed in the “Property name and aliases” column of Table 69 or Table 70.
  3. Let c be the canonical property name of p as given in the “Canonical property name” column of the corresponding row.
  4. Return the List of Unicode code points c.

Implementations must support the Unicode property names and aliases listed in Table 69, Table 70, and Table 71. To ensure interoperability, implementations must not support any other property names or aliases.

Note 1

For example, Script_Extensions (property name) and scx (property alias) are valid, but script_extensions or Scx aren't.

Note 2

The listed properties form a superset of what UTS18 RL1.2 requires.

Note 3

The spellings of entries in these tables (including casing) match the spellings used in the file PropertyAliases.txt in the Unicode Character Database. The precise spellings in that file are guaranteed to be stable.

Table 69: Non-binary Unicode property aliases and their canonical property names
Property name and aliases Canonical property name
General_Category General_Category
gc
Script Script
sc
Script_Extensions Script_Extensions
scx
Table 70: Binary Unicode property aliases and their canonical property names
Property name and aliases Canonical property name
ASCII ASCII
ASCII_Hex_Digit ASCII_Hex_Digit
AHex
Alphabetic Alphabetic
Alpha
Any Any
Assigned Assigned
Bidi_Control Bidi_Control
Bidi_C
Bidi_Mirrored Bidi_Mirrored
Bidi_M
Case_Ignorable Case_Ignorable
CI
Cased Cased
Changes_When_Casefolded Changes_When_Casefolded
CWCF
Changes_When_Casemapped Changes_When_Casemapped
CWCM
Changes_When_Lowercased Changes_When_Lowercased
CWL
Changes_When_NFKC_Casefolded Changes_When_NFKC_Casefolded
CWKCF
Changes_When_Titlecased Changes_When_Titlecased
CWT
Changes_When_Uppercased Changes_When_Uppercased
CWU
Dash Dash
Default_Ignorable_Code_Point Default_Ignorable_Code_Point
DI
Deprecated Deprecated
Dep
Diacritic Diacritic
Dia
Emoji Emoji
Emoji_Component Emoji_Component
EComp
Emoji_Modifier Emoji_Modifier
EMod
Emoji_Modifier_Base Emoji_Modifier_Base
EBase
Emoji_Presentation Emoji_Presentation
EPres
Extended_Pictographic Extended_Pictographic
ExtPict
Extender Extender
Ext
Grapheme_Base Grapheme_Base
Gr_Base
Grapheme_Extend Grapheme_Extend
Gr_Ext
Hex_Digit Hex_Digit
Hex
IDS_Binary_Operator IDS_Binary_Operator
IDSB
IDS_Trinary_Operator IDS_Trinary_Operator
IDST
ID_Continue ID_Continue
IDC
ID_Start ID_Start
IDS
Ideographic Ideographic
Ideo
Join_Control Join_Control
Join_C
Logical_Order_Exception Logical_Order_Exception
LOE
Lowercase Lowercase
Lower
Math Math
Noncharacter_Code_Point Noncharacter_Code_Point
NChar
Pattern_Syntax Pattern_Syntax
Pat_Syn
Pattern_White_Space Pattern_White_Space
Pat_WS
Quotation_Mark Quotation_Mark
QMark
Radical Radical
Regional_Indicator Regional_Indicator
RI
Sentence_Terminal Sentence_Terminal
STerm
Soft_Dotted Soft_Dotted
SD
Terminal_Punctuation Terminal_Punctuation
Term
Unified_Ideograph Unified_Ideograph
UIdeo
Uppercase Uppercase
Upper
Variation_Selector Variation_Selector
VS
White_Space White_Space
space
XID_Continue XID_Continue
XIDC
XID_Start XID_Start
XIDS
Table 71: Binary Unicode properties of strings
Property name
Basic_Emoji
Emoji_Keycap_Sequence
RGI_Emoji_Modifier_Sequence
RGI_Emoji_Flag_Sequence
RGI_Emoji_Tag_Sequence
RGI_Emoji_ZWJ_Sequence
RGI_Emoji

22.2.2.9.8 UnicodeMatchPropertyValue ( p, v )

The abstract operation UnicodeMatchPropertyValue takes arguments p (ECMAScript source text) and v (ECMAScript source text) and returns a Unicode property value. It performs the following steps when called:

  1. Assert: p is a canonical, unaliased Unicode property name listed in the “Canonical property name” column of Table 69.
  2. Assert: v is a property value or property value alias for the Unicode property p listed in PropertyValueAliases.txt.
  3. Let value be the canonical property value of v as given in the “Canonical property value” column of the corresponding row.
  4. Return the List of Unicode code points value.

Implementations must support the Unicode property values and property value aliases listed in PropertyValueAliases.txt for the properties listed in Table 69. To ensure interoperability, implementations must not support any other property values or property value aliases.

Note 1

For example, Xpeo and Old_Persian are valid Script_Extensions values, but xpeo and Old Persian aren't.

Note 2

This algorithm differs from the matching rules for symbolic values listed in UAX44: case, white space, U+002D (HYPHEN-MINUS), and U+005F (LOW LINE) are not ignored, and the Is prefix is not supported.

22.2.2.10 Runtime Semantics: CompileClassSetString

The syntax-directed operation CompileClassSetString takes argument rer (a RegExp Record) and returns a sequence of characters. It is defined piecewise over the following productions:

ClassString :: [empty]
  1. Return an empty sequence of characters.
ClassString :: NonEmptyClassString
  1. Return CompileClassSetString of NonEmptyClassString with argument rer.
NonEmptyClassString :: ClassSetCharacter NonEmptyClassStringopt
  1. Let cs be CompileToCharSet of ClassSetCharacter with argument rer.
  2. Let s1 be the sequence of characters that is the single CharSetElement of cs.
  3. If NonEmptyClassString is present, then
    1. Let s2 be CompileClassSetString of NonEmptyClassString with argument rer.
    2. Return the concatenation of s1 and s2.
  4. Return s1.

22.2.3 Abstract Operations for RegExp Creation

22.2.3.1 RegExpCreate ( P, F )

The abstract operation RegExpCreate takes arguments P (an ECMAScript language value) and F (a String or undefined) and returns either a normal completion containing an Object or a throw completion. It performs the following steps when called:

  1. Let obj be ! RegExpAlloc(%RegExp%).
  2. Return ? RegExpInitialize(obj, P, F).

22.2.3.2 RegExpAlloc ( newTarget )

The abstract operation RegExpAlloc takes argument newTarget (a constructor) and returns either a normal completion containing an Object or a throw completion. It performs the following steps when called:

  1. Let obj be ? OrdinaryCreateFromConstructor(newTarget, "%RegExp.prototype%", « [[OriginalSource]], [[OriginalFlags]], [[RegExpRecord]], [[RegExpMatcher]] »).
  2. Perform ! DefinePropertyOrThrow(obj, "lastIndex", PropertyDescriptor { [[Writable]]: true, [[Enumerable]]: false, [[Configurable]]: false }).
  3. Return obj.

22.2.3.3 RegExpInitialize ( obj, pattern, flags )

The abstract operation RegExpInitialize takes arguments obj (an Object), pattern (an ECMAScript language value), and flags (an ECMAScript language value) and returns either a normal completion containing an Object or a throw completion. It performs the following steps when called:

  1. If pattern is undefined, let P be the empty String.
  2. Else, let P be ? ToString(pattern).
  3. If flags is undefined, let F be the empty String.
  4. Else, let F be ? ToString(flags).
  5. If F contains any code unit other than "d", "g", "i", "m", "s", "u", "v", or "y", or if F contains any code unit more than once, throw a SyntaxError exception.
  6. If F contains "i", let i be true; else let i be false.
  7. If F contains "m", let m be true; else let m be false.
  8. If F contains "s", let s be true; else let s be false.
  9. If F contains "u", let u be true; else let u be false.
  10. If F contains "v", let v be true; else let v be false.
  11. If u is true or v is true, then
    1. Let patternText be StringToCodePoints(P).
  12. Else,
    1. Let patternText be the result of interpreting each of P's 16-bit elements as a Unicode BMP code point. UTF-16 decoding is not applied to the elements.
  13. Let parseResult be ParsePattern(patternText, u, v).
  14. If parseResult is a non-empty List of SyntaxError objects, throw a SyntaxError exception.
  15. Assert: parseResult is a Pattern Parse Node.
  16. Set obj.[[OriginalSource]] to P.
  17. Set obj.[[OriginalFlags]] to F.
  18. Let capturingGroupsCount be CountLeftCapturingParensWithin(parseResult).
  19. Let rer be the RegExp Record { [[IgnoreCase]]: i, [[Multiline]]: m, [[DotAll]]: s, [[Unicode]]: u, [[UnicodeSets]]: v, [[CapturingGroupsCount]]: capturingGroupsCount }.
  20. Set obj.[[RegExpRecord]] to rer.
  21. Set obj.[[RegExpMatcher]] to CompilePattern of parseResult with argument rer.
  22. Perform ? Set(obj, "lastIndex", +0𝔽, true).
  23. Return obj.

22.2.3.4 Static Semantics: ParsePattern ( patternText, u, v )

The abstract operation ParsePattern takes arguments patternText (a sequence of Unicode code points), u (a Boolean), and v (a Boolean) and returns a Parse Node or a non-empty List of SyntaxError objects.

Note

This section is amended in B.1.2.9.

It performs the following steps when called:

  1. If v is true and u is true, then
    1. Let parseResult be a List containing one or more SyntaxError objects.
  2. Else if v is true, then
    1. Let parseResult be ParseText(patternText, Pattern[+UnicodeMode, +UnicodeSetsMode, +NamedCaptureGroups]).
  3. Else if u is true, then
    1. Let parseResult be ParseText(patternText, Pattern[+UnicodeMode, ~UnicodeSetsMode, +NamedCaptureGroups]).
  4. Else,
    1. Let parseResult be ParseText(patternText, Pattern[~UnicodeMode, ~UnicodeSetsMode, +NamedCaptureGroups]).
  5. Return parseResult.

22.2.4 The RegExp Constructor

The RegExp constructor:

  • is %RegExp%.
  • is the initial value of the "RegExp" property of the global object.
  • creates and initializes a new RegExp object when called as a constructor.
  • when called as a function rather than as a constructor, returns either a new RegExp object, or the argument itself if the only argument is a RegExp object.
  • may be used as the value of an extends clause of a class definition. Subclass constructors that intend to inherit the specified RegExp behaviour must include a super call to the RegExp constructor to create and initialize subclass instances with the necessary internal slots.

22.2.4.1 RegExp ( pattern, flags )

This function performs the following steps when called:

  1. Let patternIsRegExp be ? IsRegExp(pattern).
  2. If NewTarget is undefined, then
    1. Let newTarget be the active function object.
    2. If patternIsRegExp is true and flags is undefined, then
      1. Let patternConstructor be ? Get(pattern, "constructor").
      2. If SameValue(newTarget, patternConstructor) is true, return pattern.
  3. Else,
    1. Let newTarget be NewTarget.
  4. If pattern is an Object and pattern has a [[RegExpMatcher]] internal slot, then
    1. Let P be pattern.[[OriginalSource]].
    2. If flags is undefined, let F be pattern.[[OriginalFlags]].
    3. Else, let F be flags.
  5. Else if patternIsRegExp is true, then
    1. Let P be ? Get(pattern, "source").
    2. If flags is undefined, then
      1. Let F be ? Get(pattern, "flags").
    3. Else,
      1. Let F be flags.
  6. Else,
    1. Let P be pattern.
    2. Let F be flags.
  7. Let O be ? RegExpAlloc(newTarget).
  8. Return ? RegExpInitialize(O, P, F).
Note

If pattern is supplied using a StringLiteral, the usual escape sequence substitutions are performed before the String is processed by this function. If pattern must contain an escape sequence to be recognized by this function, any U+005C (REVERSE SOLIDUS) code points must be escaped within the StringLiteral to prevent them being removed when the contents of the StringLiteral are formed.

22.2.5 Properties of the RegExp Constructor

The RegExp constructor:

  • has a [[Prototype]] internal slot whose value is %Function.prototype%.
  • has the following properties:

22.2.5.1 RegExp.escape ( S )

This function returns a copy of S in which characters that are potentially special in a regular expression Pattern have been replaced by equivalent escape sequences.

It performs the following steps when called:

  1. If S is not a String, throw a TypeError exception.
  2. Let escaped be the empty String.
  3. Let cpList be StringToCodePoints(S).
  4. For each code point cp of cpList, do
    1. If escaped is the empty String and cp is matched by either DecimalDigit or AsciiLetter, then
      1. NOTE: Escaping a leading digit ensures that output corresponds with pattern text which may be used after a \0 character escape or a DecimalEscape such as \1 and still match S rather than be interpreted as an extension of the preceding escape sequence. Escaping a leading ASCII letter does the same for the context after \c.
      2. Let numericValue be the numeric value of cp.
      3. Let hex be Number::toString(𝔽(numericValue), 16).
      4. Assert: The length of hex is 2.
      5. Set escaped to the string-concatenation of the code unit 0x005C (REVERSE SOLIDUS), "x", and hex.
    2. Else,
      1. Set escaped to the string-concatenation of escaped and EncodeForRegExpEscape(cp).
  5. Return escaped.
Note

Despite having similar names, EscapeRegExpPattern and RegExp.escape do not perform similar actions. The former escapes a pattern for representation as a string, while this function escapes a string for representation inside a pattern.

22.2.5.1.1 EncodeForRegExpEscape ( cp )

The abstract operation EncodeForRegExpEscape takes argument cp (a code point) and returns a String. It returns a String representing a Pattern for matching cp. If cp is white space or an ASCII punctuator, the returned value is an escape sequence. Otherwise, the returned value is a String representation of cp itself. It performs the following steps when called:

  1. If cp is matched by SyntaxCharacter or cp is U+002F (SOLIDUS), then
    1. Return the string-concatenation of 0x005C (REVERSE SOLIDUS) and UTF16EncodeCodePoint(cp).
  2. Else if cp is a code point listed in the “Code Point” column of Table 67, then
    1. Return the string-concatenation of 0x005C (REVERSE SOLIDUS) and the string in the “ControlEscape” column of the row whose “Code Point” column contains cp.
  3. Let otherPunctuators be the string-concatenation of ",-=<>#&!%:;@~'`" and the code unit 0x0022 (QUOTATION MARK).
  4. Let toEscape be StringToCodePoints(otherPunctuators).
  5. If toEscape contains cp, cp is matched by either WhiteSpace or LineTerminator, or cp has the same numeric value as a leading surrogate or trailing surrogate, then
    1. Let cpNum be the numeric value of cp.
    2. If cpNum ≤ 0xFF, then
      1. Let hex be Number::toString(𝔽(cpNum), 16).
      2. Return the string-concatenation of the code unit 0x005C (REVERSE SOLIDUS), "x", and StringPad(hex, 2, "0", start).
    3. Let escaped be the empty String.
    4. Let codeUnits be UTF16EncodeCodePoint(cp).
    5. For each code unit cu of codeUnits, do
      1. Set escaped to the string-concatenation of escaped and UnicodeEscape(cu).
    6. Return escaped.
  6. Return UTF16EncodeCodePoint(cp).

22.2.5.2 RegExp.prototype

The initial value of RegExp.prototype is the RegExp prototype object.

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: false }.

22.2.5.3 get RegExp [ %Symbol.species% ]

RegExp[%Symbol.species%] is an accessor property whose set accessor function is undefined. Its get accessor function performs the following steps when called:

  1. Return the this value.

The value of the "name" property of this function is "get [Symbol.species]".

Note

RegExp prototype methods normally use their this value's constructor to create a derived object. However, a subclass constructor may over-ride that default behaviour by redefining its %Symbol.species% property.

22.2.6 Properties of the RegExp Prototype Object

The RegExp prototype object:

  • is %RegExp.prototype%.
  • is an ordinary object.
  • is not a RegExp instance and does not have a [[RegExpMatcher]] internal slot or any of the other internal slots of RegExp instance objects.
  • has a [[Prototype]] internal slot whose value is %Object.prototype%.
Note

The RegExp prototype object does not have a "valueOf" property of its own; however, it inherits the "valueOf" property from the Object prototype object.

22.2.6.1 RegExp.prototype.constructor

The initial value of RegExp.prototype.constructor is %RegExp%.

22.2.6.2 RegExp.prototype.exec ( string )

This method searches string for an occurrence of the regular expression pattern and returns an Array containing the results of the match, or null if string did not match.

It performs the following steps when called:

  1. Let R be the this value.
  2. Perform ? RequireInternalSlot(R, [[RegExpMatcher]]).
  3. Let S be ? ToString(string).
  4. Return ? RegExpBuiltinExec(R, S).

22.2.6.3 get RegExp.prototype.dotAll

RegExp.prototype.dotAll is an accessor property whose set accessor function is undefined. Its get accessor function performs the following steps when called:

  1. Let R be the this value.
  2. Let cu be the code unit 0x0073 (LATIN SMALL LETTER S).
  3. Return ? RegExpHasFlag(R, cu).

22.2.6.4 get RegExp.prototype.flags

RegExp.prototype.flags is an accessor property whose set accessor function is undefined. Its get accessor function performs the following steps when called:

  1. Let R be the this value.
  2. If R is not an Object, throw a TypeError exception.
  3. Let codeUnits be a new empty List.
  4. Let hasIndices be ToBoolean(? Get(R, "hasIndices")).
  5. If hasIndices is true, append the code unit 0x0064 (LATIN SMALL LETTER D) to codeUnits.
  6. Let global be ToBoolean(? Get(R, "global")).
  7. If global is true, append the code unit 0x0067 (LATIN SMALL LETTER G) to codeUnits.
  8. Let ignoreCase be ToBoolean(? Get(R, "ignoreCase")).
  9. If ignoreCase is true, append the code unit 0x0069 (LATIN SMALL LETTER I) to codeUnits.
  10. Let multiline be ToBoolean(? Get(R, "multiline")).
  11. If multiline is true, append the code unit 0x006D (LATIN SMALL LETTER M) to codeUnits.
  12. Let dotAll be ToBoolean(? Get(R, "dotAll")).
  13. If dotAll is true, append the code unit 0x0073 (LATIN SMALL LETTER S) to codeUnits.
  14. Let unicode be ToBoolean(? Get(R, "unicode")).
  15. If unicode is true, append the code unit 0x0075 (LATIN SMALL LETTER U) to codeUnits.
  16. Let unicodeSets be ToBoolean(? Get(R, "unicodeSets")).
  17. If unicodeSets is true, append the code unit 0x0076 (LATIN SMALL LETTER V) to codeUnits.
  18. Let sticky be ToBoolean(? Get(R, "sticky")).
  19. If sticky is true, append the code unit 0x0079 (LATIN SMALL LETTER Y) to codeUnits.
  20. Return the String value whose code units are the elements of the List codeUnits. If codeUnits has no elements, the empty String is returned.

22.2.6.4.1 RegExpHasFlag ( R, codeUnit )

The abstract operation RegExpHasFlag takes arguments R (an ECMAScript language value) and codeUnit (a code unit) and returns either a normal completion containing either a Boolean or undefined, or a throw completion. It performs the following steps when called:

  1. If R is not an Object, throw a TypeError exception.
  2. If R does not have an [[OriginalFlags]] internal slot, then
    1. If SameValue(R, %RegExp.prototype%) is true, return undefined.
    2. Otherwise, throw a TypeError exception.
  3. Let flags be R.[[OriginalFlags]].
  4. If flags contains codeUnit, return true.
  5. Return false.

22.2.6.5 get RegExp.prototype.global

RegExp.prototype.global is an accessor property whose set accessor function is undefined. Its get accessor function performs the following steps when called:

  1. Let R be the this value.
  2. Let cu be the code unit 0x0067 (LATIN SMALL LETTER G).
  3. Return ? RegExpHasFlag(R, cu).

22.2.6.6 get RegExp.prototype.hasIndices

RegExp.prototype.hasIndices is an accessor property whose set accessor function is undefined. Its get accessor function performs the following steps when called:

  1. Let R be the this value.
  2. Let cu be the code unit 0x0064 (LATIN SMALL LETTER D).
  3. Return ? RegExpHasFlag(R, cu).

22.2.6.7 get RegExp.prototype.ignoreCase

RegExp.prototype.ignoreCase is an accessor property whose set accessor function is undefined. Its get accessor function performs the following steps when called:

  1. Let R be the this value.
  2. Let cu be the code unit 0x0069 (LATIN SMALL LETTER I).
  3. Return ? RegExpHasFlag(R, cu).

22.2.6.8 RegExp.prototype [ %Symbol.match% ] ( string )

This method performs the following steps when called:

  1. Let rx be the this value.
  2. If rx is not an Object, throw a TypeError exception.
  3. Let S be ? ToString(string).
  4. Let flags be ? ToString(? Get(rx, "flags")).
  5. If flags does not contain "g", then
    1. Return ? RegExpExec(rx, S).
  6. Else,
    1. If flags contains "u" or flags contains "v", let fullUnicode be true; otherwise let fullUnicode be false.
    2. Perform ? Set(rx, "lastIndex", +0𝔽, true).
    3. Let A be ! ArrayCreate(0).
    4. Let n be 0.
    5. Repeat,
      1. Let result be ? RegExpExec(rx, S).
      2. If result is null, then
        1. If n = 0, return null.
        2. Return A.
      3. Else,
        1. Let matchStr be ? ToString(? Get(result, "0")).
        2. Perform ! CreateDataPropertyOrThrow(A, ! ToString(𝔽(n)), matchStr).
        3. If matchStr is the empty String, then
          1. Let thisIndex be (? ToLength(? Get(rx, "lastIndex"))).
          2. Let nextIndex be AdvanceStringIndex(S, thisIndex, fullUnicode).
          3. Perform ? Set(rx, "lastIndex", 𝔽(nextIndex), true).
        4. Set n to n + 1.

The value of the "name" property of this method is "[Symbol.match]".

Note

The %Symbol.match% property is used by the IsRegExp abstract operation to identify objects that have the basic behaviour of regular expressions. The absence of a %Symbol.match% property or the existence of such a property whose value does not Boolean coerce to true indicates that the object is not intended to be used as a regular expression object.

22.2.6.9 RegExp.prototype [ %Symbol.matchAll% ] ( string )

This method performs the following steps when called:

  1. Let R be the this value.
  2. If R is not an Object, throw a TypeError exception.
  3. Let S be ? ToString(string).
  4. Let C be ? SpeciesConstructor(R, %RegExp%).
  5. Let flags be ? ToString(? Get(R, "flags")).
  6. Let matcher be ? Construct(C, « R, flags »).
  7. Let lastIndex be ? ToLength(? Get(R, "lastIndex")).
  8. Perform ? Set(matcher, "lastIndex", lastIndex, true).
  9. If flags contains "g", let global be true.
  10. Else, let global be false.
  11. If flags contains "u" or flags contains "v", let fullUnicode be true.
  12. Else, let fullUnicode be false.
  13. Return CreateRegExpStringIterator(matcher, S, global, fullUnicode).

The value of the "name" property of this method is "[Symbol.matchAll]".

22.2.6.10 get RegExp.prototype.multiline

RegExp.prototype.multiline is an accessor property whose set accessor function is undefined. Its get accessor function performs the following steps when called:

  1. Let R be the this value.
  2. Let cu be the code unit 0x006D (LATIN SMALL LETTER M).
  3. Return ? RegExpHasFlag(R, cu).

22.2.6.11 RegExp.prototype [ %Symbol.replace% ] ( string, replaceValue )

This method performs the following steps when called:

  1. Let rx be the this value.
  2. If rx is not an Object, throw a TypeError exception.
  3. Let S be ? ToString(string).
  4. Let lengthS be the length of S.
  5. Let functionalReplace be IsCallable(replaceValue).
  6. If functionalReplace is false, then
    1. Set replaceValue to ? ToString(replaceValue).
  7. Let flags be ? ToString(? Get(rx, "flags")).
  8. If flags contains "g", let global be true; otherwise let global be false.
  9. If global is true, then
    1. Perform ? Set(rx, "lastIndex", +0𝔽, true).
  10. Let results be a new empty List.
  11. Let done be false.
  12. Repeat, while done is false,
    1. Let result be ? RegExpExec(rx, S).
    2. If result is null, then
      1. Set done to true.
    3. Else,
      1. Append result to results.
      2. If global is false, then
        1. Set done to true.
      3. Else,
        1. Let matchStr be ? ToString(? Get(result, "0")).
        2. If matchStr is the empty String, then
          1. Let thisIndex be (? ToLength(? Get(rx, "lastIndex"))).
          2. If flags contains "u" or flags contains "v", let fullUnicode be true; otherwise let fullUnicode be false.
          3. Let nextIndex be AdvanceStringIndex(S, thisIndex, fullUnicode).
          4. Perform ? Set(rx, "lastIndex", 𝔽(nextIndex), true).
  13. Let accumulatedResult be the empty String.
  14. Let nextSourcePosition be 0.
  15. For each element result of results, do
    1. Let resultLength be ? LengthOfArrayLike(result).
    2. Let nCaptures be max(resultLength - 1, 0).
    3. Let matched be ? ToString(? Get(result, "0")).
    4. Let matchLength be the length of matched.
    5. Let position be ? ToIntegerOrInfinity(? Get(result, "index")).
    6. Set position to the result of clamping position between 0 and lengthS.
    7. Let captures be a new empty List.
    8. Let n be 1.
    9. Repeat, while nnCaptures,
      1. Let capN be ? Get(result, ! ToString(𝔽(n))).
      2. If capN is not undefined, then
        1. Set capN to ? ToString(capN).
      3. Append capN to captures.
      4. NOTE: When n = 1, the preceding step puts the first element into captures (at index 0). More generally, the nth capture (the characters captured by the nth set of capturing parentheses) is at captures[n - 1].
      5. Set n to n + 1.
    10. Let namedCaptures be ? Get(result, "groups").
    11. If functionalReplace is true, then
      1. Let replacerArgs be the list-concatenation of « matched », captures, and « 𝔽(position), S ».
      2. If namedCaptures is not undefined, then
        1. Append namedCaptures to replacerArgs.
      3. Let replacementValue be ? Call(replaceValue, undefined, replacerArgs).
      4. Let replacementString be ? ToString(replacementValue).
    12. Else,
      1. If namedCaptures is not undefined, then
        1. Set namedCaptures to ? ToObject(namedCaptures).
      2. Let replacementString be ? GetSubstitution(matched, S, position, captures, namedCaptures, replaceValue).
    13. If positionnextSourcePosition, then
      1. NOTE: position should not normally move backwards. If it does, it is an indication of an ill-behaving RegExp subclass or use of an access triggered side-effect to change the global flag or other characteristics of rx. In such cases, the corresponding substitution is ignored.
      2. Set accumulatedResult to the string-concatenation of accumulatedResult, the substring of S from nextSourcePosition to position, and replacementString.
      3. Set nextSourcePosition to position + matchLength.
  16. If nextSourcePositionlengthS, return accumulatedResult.
  17. Return the string-concatenation of accumulatedResult and the substring of S from nextSourcePosition.

The value of the "name" property of this method is "[Symbol.replace]".

22.2.6.12 RegExp.prototype [ %Symbol.search% ] ( string )

This method performs the following steps when called:

  1. Let rx be the this value.
  2. If rx is not an Object, throw a TypeError exception.
  3. Let S be ? ToString(string).
  4. Let previousLastIndex be ? Get(rx, "lastIndex").
  5. If previousLastIndex is not +0𝔽, then
    1. Perform ? Set(rx, "lastIndex", +0𝔽, true).
  6. Let result be ? RegExpExec(rx, S).
  7. Let currentLastIndex be ? Get(rx, "lastIndex").
  8. If SameValue(currentLastIndex, previousLastIndex) is false, then
    1. Perform ? Set(rx, "lastIndex", previousLastIndex, true).
  9. If result is null, return -1𝔽.
  10. Return ? Get(result, "index").

The value of the "name" property of this method is "[Symbol.search]".

Note

The "lastIndex" and "global" properties of this RegExp object are ignored when performing the search. The "lastIndex" property is left unchanged.

22.2.6.13 get RegExp.prototype.source

RegExp.prototype.source is an accessor property whose set accessor function is undefined. Its get accessor function performs the following steps when called:

  1. Let R be the this value.
  2. If R is not an Object, throw a TypeError exception.
  3. If R does not have an [[OriginalSource]] internal slot, then
    1. If SameValue(R, %RegExp.prototype%) is true, return "(?:)".
    2. Otherwise, throw a TypeError exception.
  4. Assert: R has an [[OriginalFlags]] internal slot.
  5. Let src be R.[[OriginalSource]].
  6. Let flags be R.[[OriginalFlags]].
  7. Return EscapeRegExpPattern(src, flags).

22.2.6.13.1 EscapeRegExpPattern ( P, F )

The abstract operation EscapeRegExpPattern takes arguments P (a String) and F (a String) and returns a String. It performs the following steps when called:

  1. If F contains "v", then
    1. Let patternSymbol be Pattern[+UnicodeMode, +UnicodeSetsMode].
  2. Else if F contains "u", then
    1. Let patternSymbol be Pattern[+UnicodeMode, ~UnicodeSetsMode].
  3. Else,
    1. Let patternSymbol be Pattern[~UnicodeMode, ~UnicodeSetsMode].
  4. Let S be a String in the form of a patternSymbol equivalent to P interpreted as UTF-16 encoded Unicode code points (6.1.4), in which certain code points are escaped as described below. S may or may not differ from P; however, the Abstract Closure that would result from evaluating S as a patternSymbol must behave identically to the Abstract Closure given by the constructed object's [[RegExpMatcher]] internal slot. Multiple calls to this abstract operation using the same values for P and F must produce identical results.
  5. The code points / or any LineTerminator occurring in the pattern shall be escaped in S as necessary to ensure that the string-concatenation of "/", S, "/", and F can be parsed (in an appropriate lexical context) as a RegularExpressionLiteral that behaves identically to the constructed regular expression. For example, if P is "/", then S could be "\/" or "\u002F", among other possibilities, but not "/", because /// followed by F would be parsed as a SingleLineComment rather than a RegularExpressionLiteral. If P is the empty String, this specification can be met by letting S be "(?:)".
  6. Return S.
Note

Despite having similar names, RegExp.escape and EscapeRegExpPattern do not perform similar actions. The former escapes a string for representation inside a pattern, while this function escapes a pattern for representation as a string.

22.2.6.14 RegExp.prototype [ %Symbol.split% ] ( string, limit )

Note 1

This method returns an Array into which substrings of the result of converting string to a String have been stored. The substrings are determined by searching from left to right for matches of the this value regular expression; these occurrences are not part of any String in the returned array, but serve to divide up the String value.

The this value may be an empty regular expression or a regular expression that can match an empty String. In this case, the regular expression does not match the empty substring at the beginning or end of the input String, nor does it match the empty substring at the end of the previous separator match. (For example, if the regular expression matches the empty String, the String is split up into individual code unit elements; the length of the result array equals the length of the String, and each substring contains one code unit.) Only the first match at a given index of the String is considered, even if backtracking could yield a non-empty substring match at that index. (For example, /a*?/[Symbol.split]("ab") evaluates to the array ["a", "b"], while /a*/[Symbol.split]("ab") evaluates to the array ["","b"].)

If string is (or converts to) the empty String, the result depends on whether the regular expression can match the empty String. If it can, the result array contains no elements. Otherwise, the result array contains one element, which is the empty String.

If the regular expression contains capturing parentheses, then each time separator is matched the results (including any undefined results) of the capturing parentheses are spliced into the output array. For example,

/<(\/)?([^<>]+)>/[Symbol.split]("A<B>bold</B>and<CODE>coded</CODE>")

evaluates to the array

["A", undefined, "B", "bold", "/", "B", "and", undefined, "CODE", "coded", "/", "CODE", ""]

If limit is not undefined, then the output array is truncated so that it contains no more than limit elements.

This method performs the following steps when called:

  1. Let rx be the this value.
  2. If rx is not an Object, throw a TypeError exception.
  3. Let S be ? ToString(string).
  4. Let C be ? SpeciesConstructor(rx, %RegExp%).
  5. Let flags be ? ToString(? Get(rx, "flags")).
  6. If flags contains "u" or flags contains "v", let unicodeMatching be true.
  7. Else, let unicodeMatching be false.
  8. If flags contains "y", let newFlags be flags.
  9. Else, let newFlags be the string-concatenation of flags and "y".
  10. Let splitter be ? Construct(C, « rx, newFlags »).
  11. Let A be ! ArrayCreate(0).
  12. Let lengthA be 0.
  13. If limit is undefined, let lim be 232 - 1; else let lim be (? ToUint32(limit)).
  14. If lim = 0, return A.
  15. If S is the empty String, then
    1. Let z be ? RegExpExec(splitter, S).
    2. If z is not null, return A.
    3. Perform ! CreateDataPropertyOrThrow(A, "0", S).
    4. Return A.
  16. Let size be the length of S.
  17. Let p be 0.
  18. Let q be p.
  19. Repeat, while q < size,
    1. Perform ? Set(splitter, "lastIndex", 𝔽(q), true).
    2. Let z be ? RegExpExec(splitter, S).
    3. If z is null, then
      1. Set q to AdvanceStringIndex(S, q, unicodeMatching).
    4. Else,
      1. Let e be (? ToLength(? Get(splitter, "lastIndex"))).
      2. Set e to min(e, size).
      3. If e = p, then
        1. Set q to AdvanceStringIndex(S, q, unicodeMatching).
      4. Else,
        1. Let T be the substring of S from p to q.
        2. Perform ! CreateDataPropertyOrThrow(A, ! ToString(𝔽(lengthA)), T).
        3. Set lengthA to lengthA + 1.
        4. If lengthA = lim, return A.
        5. Set p to e.
        6. Let numberOfCaptures be ? LengthOfArrayLike(z).
        7. Set numberOfCaptures to max(numberOfCaptures - 1, 0).
        8. Let i be 1.
        9. Repeat, while inumberOfCaptures,
          1. Let nextCapture be ? Get(z, ! ToString(𝔽(i))).
          2. Perform ! CreateDataPropertyOrThrow(A, ! ToString(𝔽(lengthA)), nextCapture).
          3. Set i to i + 1.
          4. Set lengthA to lengthA + 1.
          5. If lengthA = lim, return A.
        10. Set q to p.
  20. Let T be the substring of S from p to size.
  21. Perform ! CreateDataPropertyOrThrow(A, ! ToString(𝔽(lengthA)), T).
  22. Return A.

The value of the "name" property of this method is "[Symbol.split]".

Note 2

This method ignores the value of the "global" and "sticky" properties of this RegExp object.

22.2.6.15 get RegExp.prototype.sticky

RegExp.prototype.sticky is an accessor property whose set accessor function is undefined. Its get accessor function performs the following steps when called:

  1. Let R be the this value.
  2. Let cu be the code unit 0x0079 (LATIN SMALL LETTER Y).
  3. Return ? RegExpHasFlag(R, cu).

22.2.6.16 RegExp.prototype.test ( S )

This method performs the following steps when called:

  1. Let R be the this value.
  2. If R is not an Object, throw a TypeError exception.
  3. Let string be ? ToString(S).
  4. Let match be ? RegExpExec(R, string).
  5. If match is not null, return true; else return false.

22.2.6.17 RegExp.prototype.toString ( )

  1. Let R be the this value.
  2. If R is not an Object, throw a TypeError exception.
  3. Let pattern be ? ToString(? Get(R, "source")).
  4. Let flags be ? ToString(? Get(R, "flags")).
  5. Let result be the string-concatenation of "/", pattern, "/", and flags.
  6. Return result.
Note

The returned String has the form of a RegularExpressionLiteral that evaluates to another RegExp object with the same behaviour as this object.

22.2.6.18 get RegExp.prototype.unicode

RegExp.prototype.unicode is an accessor property whose set accessor function is undefined. Its get accessor function performs the following steps when called:

  1. Let R be the this value.
  2. Let cu be the code unit 0x0075 (LATIN SMALL LETTER U).
  3. Return ? RegExpHasFlag(R, cu).

22.2.6.19 get RegExp.prototype.unicodeSets

RegExp.prototype.unicodeSets is an accessor property whose set accessor function is undefined. Its get accessor function performs the following steps when called:

  1. Let R be the this value.
  2. Let cu be the code unit 0x0076 (LATIN SMALL LETTER V).
  3. Return ? RegExpHasFlag(R, cu).

22.2.7 Abstract Operations for RegExp Matching

22.2.7.1 RegExpExec ( R, S )

The abstract operation RegExpExec takes arguments R (an Object) and S (a String) and returns either a normal completion containing either an Object or null, or a throw completion. It performs the following steps when called:

  1. Let exec be ? Get(R, "exec").
  2. If IsCallable(exec) is true, then
    1. Let result be ? Call(exec, R, « S »).
    2. If result is not an Object and result is not null, throw a TypeError exception.
    3. Return result.
  3. Perform ? RequireInternalSlot(R, [[RegExpMatcher]]).
  4. Return ? RegExpBuiltinExec(R, S).
Note

If a callable "exec" property is not found this algorithm falls back to attempting to use the built-in RegExp matching algorithm. This provides compatible behaviour for code written for prior editions where most built-in algorithms that use regular expressions did not perform a dynamic property lookup of "exec".

22.2.7.2 RegExpBuiltinExec ( R, S )

The abstract operation RegExpBuiltinExec takes arguments R (an initialized RegExp instance) and S (a String) and returns either a normal completion containing either an Array exotic object or null, or a throw completion. It performs the following steps when called:

  1. Let length be the length of S.
  2. Let lastIndex be (? ToLength(? Get(R, "lastIndex"))).
  3. Let flags be R.[[OriginalFlags]].
  4. If flags contains "g", let global be true; else let global be false.
  5. If flags contains "y", let sticky be true; else let sticky be false.
  6. If flags contains "d", let hasIndices be true; else let hasIndices be false.
  7. If global is false and sticky is false, set lastIndex to 0.
  8. Let matcher be R.[[RegExpMatcher]].
  9. If flags contains "u" or flags contains "v", let fullUnicode be true; else let fullUnicode be false.
  10. Let matchSucceeded be false.
  11. If fullUnicode is true, let input be StringToCodePoints(S); otherwise let input be a List whose elements are the code units that are the elements of S.
  12. NOTE: Each element of input is considered to be a character.
  13. Repeat, while matchSucceeded is false,
    1. If lastIndex > length, then
      1. If global is true or sticky is true, then
        1. Perform ? Set(R, "lastIndex", +0𝔽, true).
      2. Return null.
    2. Let inputIndex be the index into input of the character that was obtained from element lastIndex of S.
    3. Let r be matcher(input, inputIndex).
    4. If r is failure, then
      1. If sticky is true, then
        1. Perform ? Set(R, "lastIndex", +0𝔽, true).
        2. Return null.
      2. Set lastIndex to AdvanceStringIndex(S, lastIndex, fullUnicode).
    5. Else,
      1. Assert: r is a MatchState.
      2. Set matchSucceeded to true.
  14. Let e be r.[[EndIndex]].
  15. If fullUnicode is true, set e to GetStringIndex(S, e).
  16. If global is true or sticky is true, then
    1. Perform ? Set(R, "lastIndex", 𝔽(e), true).
  17. Let n be the number of elements in r.[[Captures]].
  18. Assert: n = R.[[RegExpRecord]].[[CapturingGroupsCount]].
  19. Assert: n < 232 - 1.
  20. Let A be ! ArrayCreate(n + 1).
  21. Assert: The mathematical value of A's "length" property is n + 1.
  22. Perform ! CreateDataPropertyOrThrow(A, "index", 𝔽(lastIndex)).
  23. Perform ! CreateDataPropertyOrThrow(A, "input", S).
  24. Let match be the Match Record { [[StartIndex]]: lastIndex, [[EndIndex]]: e }.
  25. Let indices be a new empty List.
  26. Let groupNames be a new empty List.
  27. Append match to indices.
  28. Let matchedSubstr be GetMatchString(S, match).
  29. Perform ! CreateDataPropertyOrThrow(A, "0", matchedSubstr).
  30. If R contains any GroupName, then
    1. Let groups be OrdinaryObjectCreate(null).
    2. Let hasGroups be true.
  31. Else,
    1. Let groups be undefined.
    2. Let hasGroups be false.
  32. Perform ! CreateDataPropertyOrThrow(A, "groups", groups).
  33. Let matchedGroupNames be a new empty List.
  34. For each integer i such that 1 ≤ in, in ascending order, do
    1. Let captureI be ith element of r.[[Captures]].
    2. If captureI is undefined, then
      1. Let capturedValue be undefined.
      2. Append undefined to indices.
    3. Else,
      1. Let captureStart be captureI.[[StartIndex]].
      2. Let captureEnd be captureI.[[EndIndex]].
      3. If fullUnicode is true, then
        1. Set captureStart to GetStringIndex(S, captureStart).
        2. Set captureEnd to GetStringIndex(S, captureEnd).
      4. Let capture be the Match Record { [[StartIndex]]: captureStart, [[EndIndex]]: captureEnd }.
      5. Let capturedValue be GetMatchString(S, capture).
      6. Append capture to indices.
    4. Perform ! CreateDataPropertyOrThrow(A, ! ToString(𝔽(i)), capturedValue).
    5. If the ith capture of R was defined with a GroupName, then
      1. Let s be the CapturingGroupName of that GroupName.
      2. If matchedGroupNames contains s, then
        1. Assert: capturedValue is undefined.
        2. Append undefined to groupNames.
      3. Else,
        1. If capturedValue is not undefined, append s to matchedGroupNames.
        2. NOTE: If there are multiple groups named s, groups may already have an s property at this point. However, because groups is an ordinary object whose properties are all writable data properties, the call to CreateDataPropertyOrThrow is nevertheless guaranteed to succeed.
        3. Perform ! CreateDataPropertyOrThrow(groups, s, capturedValue).
        4. Append s to groupNames.
    6. Else,
      1. Append undefined to groupNames.
  35. If hasIndices is true, then
    1. Let indicesArray be MakeMatchIndicesIndexPairArray(S, indices, groupNames, hasGroups).
    2. Perform ! CreateDataPropertyOrThrow(A, "indices", indicesArray).
  36. Return A.

22.2.7.3 AdvanceStringIndex ( S, index, unicode )

The abstract operation AdvanceStringIndex takes arguments S (a String), index (a non-negative integer), and unicode (a Boolean) and returns an integer. It performs the following steps when called:

  1. Assert: index ≤ 253 - 1.
  2. If unicode is false, return index + 1.
  3. Let length be the length of S.
  4. If index + 1 ≥ length, return index + 1.
  5. Let cp be CodePointAt(S, index).
  6. Return index + cp.[[CodeUnitCount]].

22.2.7.4 GetStringIndex ( S, codePointIndex )

The abstract operation GetStringIndex takes arguments S (a String) and codePointIndex (a non-negative integer) and returns a non-negative integer. It interprets S as a sequence of UTF-16 encoded code points, as described in 6.1.4, and returns the code unit index corresponding to code point index codePointIndex when such an index exists. Otherwise, it returns the length of S. It performs the following steps when called:

  1. If S is the empty String, return 0.
  2. Let len be the length of S.
  3. Let codeUnitCount be 0.
  4. Let codePointCount be 0.
  5. Repeat, while codeUnitCount < len,
    1. If codePointCount = codePointIndex, return codeUnitCount.
    2. Let cp be CodePointAt(S, codeUnitCount).
    3. Set codeUnitCount to codeUnitCount + cp.[[CodeUnitCount]].
    4. Set codePointCount to codePointCount + 1.
  6. Return len.

22.2.7.5 Match Records

A Match Record is a Record value used to encapsulate the start and end indices of a regular expression match or capture.

Match Records have the fields listed in Table 72.

Table 72: Match Record Fields
Field Name Value Meaning
[[StartIndex]] a non-negative integer The number of code units from the start of a string at which the match begins (inclusive).
[[EndIndex]] an integer[[StartIndex]] The number of code units from the start of a string at which the match ends (exclusive).

22.2.7.6 GetMatchString ( S, match )

The abstract operation GetMatchString takes arguments S (a String) and match (a Match Record) and returns a String. It performs the following steps when called:

  1. Assert: match.[[StartIndex]]match.[[EndIndex]] ≤ the length of S.
  2. Return the substring of S from match.[[StartIndex]] to match.[[EndIndex]].

22.2.7.7 GetMatchIndexPair ( S, match )

The abstract operation GetMatchIndexPair takes arguments S (a String) and match (a Match Record) and returns an Array. It performs the following steps when called:

  1. Assert: match.[[StartIndex]]match.[[EndIndex]] ≤ the length of S.
  2. Return CreateArrayFromList𝔽(match.[[StartIndex]]), 𝔽(match.[[EndIndex]]) »).

22.2.7.8 MakeMatchIndicesIndexPairArray ( S, indices, groupNames, hasGroups )

The abstract operation MakeMatchIndicesIndexPairArray takes arguments S (a String), indices (a List of either Match Records or undefined), groupNames (a List of either Strings or undefined), and hasGroups (a Boolean) and returns an Array. It performs the following steps when called:

  1. Let n be the number of elements in indices.
  2. Assert: n < 232 - 1.
  3. Assert: groupNames has n - 1 elements.
  4. NOTE: The groupNames List contains elements aligned with the indices List starting at indices[1].
  5. Let A be ! ArrayCreate(n).
  6. If hasGroups is true, then
    1. Let groups be OrdinaryObjectCreate(null).
  7. Else,
    1. Let groups be undefined.
  8. Perform ! CreateDataPropertyOrThrow(A, "groups", groups).
  9. For each integer i such that 0 ≤ i < n, in ascending order, do
    1. Let matchIndices be indices[i].
    2. If matchIndices is not undefined, then
      1. Let matchIndexPair be GetMatchIndexPair(S, matchIndices).
    3. Else,
      1. Let matchIndexPair be undefined.
    4. Perform ! CreateDataPropertyOrThrow(A, ! ToString(𝔽(i)), matchIndexPair).
    5. If i > 0, then
      1. Let s be groupNames[i - 1].
      2. If s is not undefined, then
        1. Assert: groups is not undefined.
        2. NOTE: If there are multiple groups named s, groups may already have an s property at this point. However, because groups is an ordinary object whose properties are all writable data properties, the call to CreateDataPropertyOrThrow is nevertheless guaranteed to succeed.
        3. Perform ! CreateDataPropertyOrThrow(groups, s, matchIndexPair).
  10. Return A.

22.2.8 Properties of RegExp Instances

RegExp instances are ordinary objects that inherit properties from the RegExp prototype object. RegExp instances have internal slots [[OriginalSource]], [[OriginalFlags]], [[RegExpRecord]], and [[RegExpMatcher]]. The value of the [[RegExpMatcher]] internal slot is an Abstract Closure representation of the Pattern of the RegExp object.

Note

Prior to ECMAScript 2015, RegExp instances were specified as having the own data properties "source", "global", "ignoreCase", and "multiline". Those properties are now specified as accessor properties of RegExp.prototype.

RegExp instances also have the following property:

22.2.8.1 lastIndex

The value of the "lastIndex" property specifies the String index at which to start the next match. It is coerced to an integral Number when used (see 22.2.7.2). This property shall have the attributes { [[Writable]]: true, [[Enumerable]]: false, [[Configurable]]: false }.

22.2.9 RegExp String Iterator Objects

A RegExp String Iterator is an object that represents a specific iteration over some specific String instance object, matching against some specific RegExp instance object. There is not a named constructor for RegExp String Iterator objects. Instead, RegExp String Iterator objects are created by calling certain methods of RegExp instance objects.

22.2.9.1 CreateRegExpStringIterator ( R, S, global, fullUnicode )

The abstract operation CreateRegExpStringIterator takes arguments R (an Object), S (a String), global (a Boolean), and fullUnicode (a Boolean) and returns an Object. It performs the following steps when called:

  1. Let iterator be OrdinaryObjectCreate(%RegExpStringIteratorPrototype%, « [[IteratingRegExp]], [[IteratedString]], [[Global]], [[Unicode]], [[Done]] »).
  2. Set iterator.[[IteratingRegExp]] to R.
  3. Set iterator.[[IteratedString]] to S.
  4. Set iterator.[[Global]] to global.
  5. Set iterator.[[Unicode]] to fullUnicode.
  6. Set iterator.[[Done]] to false.
  7. Return iterator.

22.2.9.2 The %RegExpStringIteratorPrototype% Object

The %RegExpStringIteratorPrototype% object:

22.2.9.2.1 %RegExpStringIteratorPrototype%.next ( )

  1. Let O be the this value.
  2. If O is not an Object, throw a TypeError exception.
  3. If O does not have all of the internal slots of a RegExp String Iterator Object Instance (see 22.2.9.3), throw a TypeError exception.
  4. If O.[[Done]] is true, then
    1. Return CreateIteratorResultObject(undefined, true).
  5. Let R be O.[[IteratingRegExp]].
  6. Let S be O.[[IteratedString]].
  7. Let global be O.[[Global]].
  8. Let fullUnicode be O.[[Unicode]].
  9. Let match be ? RegExpExec(R, S).
  10. If match is null, then
    1. Set O.[[Done]] to true.
    2. Return CreateIteratorResultObject(undefined, true).
  11. If global is false, then
    1. Set O.[[Done]] to true.
    2. Return CreateIteratorResultObject(match, false).
  12. Let matchStr be ? ToString(? Get(match, "0")).
  13. If matchStr is the empty String, then
    1. Let thisIndex be (? ToLength(? Get(R, "lastIndex"))).
    2. Let nextIndex be AdvanceStringIndex(S, thisIndex, fullUnicode).
    3. Perform ? Set(R, "lastIndex", 𝔽(nextIndex), true).
  14. Return CreateIteratorResultObject(match, false).

22.2.9.2.2 %RegExpStringIteratorPrototype% [ %Symbol.toStringTag% ]

The initial value of the %Symbol.toStringTag% property is the String value "RegExp String Iterator".

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: true }.

22.2.9.3 Properties of RegExp String Iterator Instances

RegExp String Iterator instances are ordinary objects that inherit properties from the %RegExpStringIteratorPrototype% intrinsic object. RegExp String Iterator instances are initially created with the internal slots listed in Table 73.

Table 73: Internal Slots of RegExp String Iterator Instances
Internal Slot Type Description
[[IteratingRegExp]] an Object The regular expression used for iteration. IsRegExp([[IteratingRegExp]]) is initially true.
[[IteratedString]] a String The String value being iterated upon.
[[Global]] a Boolean Indicates whether the [[IteratingRegExp]] is global or not.
[[Unicode]] a Boolean Indicates whether the [[IteratingRegExp]] is in Unicode mode or not.
[[Done]] a Boolean Indicates whether the iteration is complete or not.

23 Indexed Collections

23.1 Array Objects

Arrays are exotic objects that give special treatment to a certain class of property names. See 10.4.2 for a definition of this special treatment.

23.1.1 The Array Constructor

The Array constructor:

  • is %Array%.
  • is the initial value of the "Array" property of the global object.
  • creates and initializes a new Array when called as a constructor.
  • also creates and initializes a new Array when called as a function rather than as a constructor. Thus the function call Array(…) is equivalent to the object creation expression new Array(…) with the same arguments.
  • is a function whose behaviour differs based upon the number and types of its arguments.
  • may be used as the value of an extends clause of a class definition. Subclass constructors that intend to inherit the exotic Array behaviour must include a super call to the Array constructor to initialize subclass instances that are Array exotic objects. However, most of the Array.prototype methods are generic methods that are not dependent upon their this value being an Array exotic object.

23.1.1.1 Array ( ...values )

This function performs the following steps when called:

  1. If NewTarget is undefined, let newTarget be the active function object; else let newTarget be NewTarget.
  2. Let proto be ? GetPrototypeFromConstructor(newTarget, "%Array.prototype%").
  3. Let numberOfArgs be the number of elements in values.
  4. If numberOfArgs = 0, then
    1. Return ! ArrayCreate(0, proto).
  5. Else if numberOfArgs = 1, then
    1. Let len be values[0].
    2. Let array be ! ArrayCreate(0, proto).
    3. If len is not a Number, then
      1. Perform ! CreateDataPropertyOrThrow(array, "0", len).
      2. Let intLen be 1𝔽.
    4. Else,
      1. Let intLen be ! ToUint32(len).
      2. If SameValueZero(intLen, len) is false, throw a RangeError exception.
    5. Perform ! Set(array, "length", intLen, true).
    6. Return array.
  6. Else,
    1. Assert: numberOfArgs ≥ 2.
    2. Let array be ? ArrayCreate(numberOfArgs, proto).
    3. Let k be 0.
    4. Repeat, while k < numberOfArgs,
      1. Let Pk be ! ToString(𝔽(k)).
      2. Let itemK be values[k].
      3. Perform ! CreateDataPropertyOrThrow(array, Pk, itemK).
      4. Set k to k + 1.
    5. Assert: The mathematical value of array's "length" property is numberOfArgs.
    6. Return array.

23.1.2 Properties of the Array Constructor

The Array constructor:

  • has a [[Prototype]] internal slot whose value is %Function.prototype%.
  • has a "length" property whose value is 1𝔽.
  • has the following properties:

23.1.2.1 Array.from ( items [ , mapper [ , thisArg ] ] )

This method performs the following steps when called:

  1. Let C be the this value.
  2. If mapper is undefined, then
    1. Let mapping be false.
  3. Else,
    1. If IsCallable(mapper) is false, throw a TypeError exception.
    2. Let mapping be true.
  4. Let usingIterator be ? GetMethod(items, %Symbol.iterator%).
  5. If usingIterator is not undefined, then
    1. If IsConstructor(C) is true, then
      1. Let A be ? Construct(C).
    2. Else,
      1. Let A be ! ArrayCreate(0).
    3. Let iteratorRecord be ? GetIteratorFromMethod(items, usingIterator).
    4. Let k be 0.
    5. Repeat,
      1. If k ≥ 253 - 1, then
        1. Let error be ThrowCompletion(a newly created TypeError object).
        2. Return ? IteratorClose(iteratorRecord, error).
      2. Let Pk be ! ToString(𝔽(k)).
      3. Let next be ? IteratorStepValue(iteratorRecord).
      4. If next is done, then
        1. Perform ? Set(A, "length", 𝔽(k), true).
        2. Return A.
      5. If mapping is true, then
        1. Let mappedValue be Completion(Call(mapper, thisArg, « next, 𝔽(k) »)).
        2. IfAbruptCloseIterator(mappedValue, iteratorRecord).
      6. Else,
        1. Let mappedValue be next.
      7. Let defineStatus be Completion(CreateDataPropertyOrThrow(A, Pk, mappedValue)).
      8. IfAbruptCloseIterator(defineStatus, iteratorRecord).
      9. Set k to k + 1.
  6. NOTE: items is not iterable so assume it is an array-like object.
  7. Let arrayLike be ! ToObject(items).
  8. Let len be ? LengthOfArrayLike(arrayLike).
  9. If IsConstructor(C) is true, then
    1. Let A be ? Construct(C, « 𝔽(len) »).
  10. Else,
    1. Let A be ? ArrayCreate(len).
  11. Let k be 0.
  12. Repeat, while k < len,
    1. Let Pk be ! ToString(𝔽(k)).
    2. Let kValue be ? Get(arrayLike, Pk).
    3. If mapping is true, then
      1. Let mappedValue be ? Call(mapper, thisArg, « kValue, 𝔽(k) »).
    4. Else,
      1. Let mappedValue be kValue.
    5. Perform ? CreateDataPropertyOrThrow(A, Pk, mappedValue).
    6. Set k to k + 1.
  13. Perform ? Set(A, "length", 𝔽(len), true).
  14. Return A.
Note

This method is an intentionally generic factory method; it does not require that its this value be the Array constructor. Therefore it can be transferred to or inherited by any other constructors that may be called with a single numeric argument.

23.1.2.2 Array.isArray ( arg )

This function performs the following steps when called:

  1. Return ? IsArray(arg).

23.1.2.3 Array.of ( ...items )

This method performs the following steps when called:

  1. Let len be the number of elements in items.
  2. Let lenNumber be 𝔽(len).
  3. Let C be the this value.
  4. If IsConstructor(C) is true, then
    1. Let A be ? Construct(C, « lenNumber »).
  5. Else,
    1. Let A be ? ArrayCreate(len).
  6. Let k be 0.
  7. Repeat, while k < len,
    1. Let kValue be items[k].
    2. Let Pk be ! ToString(𝔽(k)).
    3. Perform ? CreateDataPropertyOrThrow(A, Pk, kValue).
    4. Set k to k + 1.
  8. Perform ? Set(A, "length", lenNumber, true).
  9. Return A.
Note

This method is an intentionally generic factory method; it does not require that its this value be the Array constructor. Therefore it can be transferred to or inherited by other constructors that may be called with a single numeric argument.

23.1.2.4 Array.prototype

The value of Array.prototype is the Array prototype object.

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: false }.

23.1.2.5 get Array [ %Symbol.species% ]

Array[%Symbol.species%] is an accessor property whose set accessor function is undefined. Its get accessor function performs the following steps when called:

  1. Return the this value.

The value of the "name" property of this function is "get [Symbol.species]".

Note

Array prototype methods normally use their this value's constructor to create a derived object. However, a subclass constructor may over-ride that default behaviour by redefining its %Symbol.species% property.

23.1.3 Properties of the Array Prototype Object

The Array prototype object:

  • is %Array.prototype%.
  • is an Array exotic object and has the internal methods specified for such objects.
  • has a "length" property whose initial value is +0𝔽 and whose attributes are { [[Writable]]: true, [[Enumerable]]: false, [[Configurable]]: false }.
  • has a [[Prototype]] internal slot whose value is %Object.prototype%.
Note

The Array prototype object is specified to be an Array exotic object to ensure compatibility with ECMAScript code that was created prior to the ECMAScript 2015 specification.

23.1.3.1 Array.prototype.at ( index )

  1. Let O be ? ToObject(this value).
  2. Let len be ? LengthOfArrayLike(O).
  3. Let relativeIndex be ? ToIntegerOrInfinity(index).
  4. If relativeIndex ≥ 0, then
    1. Let k be relativeIndex.
  5. Else,
    1. Let k be len + relativeIndex.
  6. If k < 0 or klen, return undefined.
  7. Return ? Get(O, ! ToString(𝔽(k))).

23.1.3.2 Array.prototype.concat ( ...items )

This method returns an array containing the array elements of the object followed by the array elements of each argument.

It performs the following steps when called:

  1. Let O be ? ToObject(this value).
  2. Let A be ? ArraySpeciesCreate(O, 0).
  3. Let n be 0.
  4. Prepend O to items.
  5. For each element E of items, do
    1. Let spreadable be ? IsConcatSpreadable(E).
    2. If spreadable is true, then
      1. Let len be ? LengthOfArrayLike(E).
      2. If n + len > 253 - 1, throw a TypeError exception.
      3. Let k be 0.
      4. Repeat, while k < len,
        1. Let Pk be ! ToString(𝔽(k)).
        2. Let exists be ? HasProperty(E, Pk).
        3. If exists is true, then
          1. Let subElement be ? Get(E, Pk).
          2. Perform ? CreateDataPropertyOrThrow(A, ! ToString(𝔽(n)), subElement).
        4. Set n to n + 1.
        5. Set k to k + 1.
    3. Else,
      1. NOTE: E is added as a single item rather than spread.
      2. If n ≥ 253 - 1, throw a TypeError exception.
      3. Perform ? CreateDataPropertyOrThrow(A, ! ToString(𝔽(n)), E).
      4. Set n to n + 1.
  6. Perform ? Set(A, "length", 𝔽(n), true).
  7. Return A.

The "length" property of this method is 1𝔽.

Note 1

The explicit setting of the "length" property in step 6 is intended to ensure the length is correct when the final non-empty element of items has trailing holes or when A is not a built-in Array.

Note 2

This method is intentionally generic; it does not require that its this value be an Array. Therefore it can be transferred to other kinds of objects for use as a method.

23.1.3.2.1 IsConcatSpreadable ( O )

The abstract operation IsConcatSpreadable takes argument O (an ECMAScript language value) and returns either a normal completion containing a Boolean or a throw completion. It performs the following steps when called:

  1. If O is not an Object, return false.
  2. Let spreadable be ? Get(O, %Symbol.isConcatSpreadable%).
  3. If spreadable is not undefined, return ToBoolean(spreadable).
  4. Return ? IsArray(O).

23.1.3.3 Array.prototype.constructor

The initial value of Array.prototype.constructor is %Array%.

23.1.3.4 Array.prototype.copyWithin ( target, start [ , end ] )

Note 1

The end argument is optional. If it is not provided, the length of the this value is used.

Note 2

If target is negative, it is treated as length + target where length is the length of the array. If start is negative, it is treated as length + start. If end is negative, it is treated as length + end.

This method performs the following steps when called:

  1. Let O be ? ToObject(this value).
  2. Let len be ? LengthOfArrayLike(O).
  3. Let relativeTarget be ? ToIntegerOrInfinity(target).
  4. If relativeTarget = -∞, let to be 0.
  5. Else if relativeTarget < 0, let to be max(len + relativeTarget, 0).
  6. Else, let to be min(relativeTarget, len).
  7. Let relativeStart be ? ToIntegerOrInfinity(start).
  8. If relativeStart = -∞, let from be 0.
  9. Else if relativeStart < 0, let from be max(len + relativeStart, 0).
  10. Else, let from be min(relativeStart, len).
  11. If end is undefined, let relativeEnd be len; else let relativeEnd be ? ToIntegerOrInfinity(end).
  12. If relativeEnd = -∞, let final be 0.
  13. Else if relativeEnd < 0, let final be max(len + relativeEnd, 0).
  14. Else, let final be min(relativeEnd, len).
  15. Let count be min(final - from, len - to).
  16. If from < to and to < from + count, then
    1. Let direction be -1.
    2. Set from to from + count - 1.
    3. Set to to to + count - 1.
  17. Else,
    1. Let direction be 1.
  18. Repeat, while count > 0,
    1. Let fromKey be ! ToString(𝔽(from)).
    2. Let toKey be ! ToString(𝔽(to)).
    3. Let fromPresent be ? HasProperty(O, fromKey).
    4. If fromPresent is true, then
      1. Let fromValue be ? Get(O, fromKey).
      2. Perform ? Set(O, toKey, fromValue, true).
    5. Else,
      1. Assert: fromPresent is false.
      2. Perform ? DeletePropertyOrThrow(O, toKey).
    6. Set from to from + direction.
    7. Set to to to + direction.
    8. Set count to count - 1.
  19. Return O.
Note 3

This method is intentionally generic; it does not require that its this value be an Array. Therefore it can be transferred to other kinds of objects for use as a method.

23.1.3.5 Array.prototype.entries ( )

This method performs the following steps when called:

  1. Let O be ? ToObject(this value).
  2. Return CreateArrayIterator(O, key+value).

23.1.3.6 Array.prototype.every ( callback [ , thisArg ] )

Note 1

callback should be a function that accepts three arguments and returns a value that is coercible to a Boolean value. every calls callback once for each element present in the array, in ascending order, until it finds one where callback returns false. If such an element is found, every immediately returns false. Otherwise, every returns true. callback is called only for elements of the array which actually exist; it is not called for missing elements of the array.

If a thisArg parameter is provided, it will be used as the this value for each invocation of callback. If it is not provided, undefined is used instead.

callback is called with three arguments: the value of the element, the index of the element, and the object being traversed.

every does not directly mutate the object on which it is called but the object may be mutated by the calls to callback.

The range of elements processed by every is set before the first call to callback. Elements which are appended to the array after the call to every begins will not be visited by callback. If existing elements of the array are changed, their value as passed to callback will be the value at the time every visits them; elements that are deleted after the call to every begins and before being visited are not visited. every acts like the "for all" quantifier in mathematics. In particular, for an empty array, it returns true.

This method performs the following steps when called:

  1. Let O be ? ToObject(this value).
  2. Let len be ? LengthOfArrayLike(O).
  3. If IsCallable(callback) is false, throw a TypeError exception.
  4. Let k be 0.
  5. Repeat, while k < len,
    1. Let Pk be ! ToString(𝔽(k)).
    2. Let kPresent be ? HasProperty(O, Pk).
    3. If kPresent is true, then
      1. Let kValue be ? Get(O, Pk).
      2. Let testResult be ToBoolean(? Call(callback, thisArg, « kValue, 𝔽(k), O »)).
      3. If testResult is false, return false.
    4. Set k to k + 1.
  6. Return true.
Note 2

This method is intentionally generic; it does not require that its this value be an Array. Therefore it can be transferred to other kinds of objects for use as a method.

23.1.3.7 Array.prototype.fill ( value [ , start [ , end ] ] )

Note 1

The start argument is optional. If it is not provided, +0𝔽 is used.

The end argument is optional. If it is not provided, the length of the this value is used.

Note 2

If start is negative, it is treated as length + start where length is the length of the array. If end is negative, it is treated as length + end.

This method performs the following steps when called:

  1. Let O be ? ToObject(this value).
  2. Let len be ? LengthOfArrayLike(O).
  3. Let relativeStart be ? ToIntegerOrInfinity(start).
  4. If relativeStart = -∞, let k be 0.
  5. Else if relativeStart < 0, let k be max(len + relativeStart, 0).
  6. Else, let k be min(relativeStart, len).
  7. If end is undefined, let relativeEnd be len; else let relativeEnd be ? ToIntegerOrInfinity(end).
  8. If relativeEnd = -∞, let final be 0.
  9. Else if relativeEnd < 0, let final be max(len + relativeEnd, 0).
  10. Else, let final be min(relativeEnd, len).
  11. Repeat, while k < final,
    1. Let Pk be ! ToString(𝔽(k)).
    2. Perform ? Set(O, Pk, value, true).
    3. Set k to k + 1.
  12. Return O.
Note 3

This method is intentionally generic; it does not require that its this value be an Array. Therefore it can be transferred to other kinds of objects for use as a method.

23.1.3.8 Array.prototype.filter ( callback [ , thisArg ] )

Note 1

callback should be a function that accepts three arguments and returns a value that is coercible to a Boolean value. filter calls callback once for each element in the array, in ascending order, and constructs a new array of all the values for which callback returns true. callback is called only for elements of the array which actually exist; it is not called for missing elements of the array.

If a thisArg parameter is provided, it will be used as the this value for each invocation of callback. If it is not provided, undefined is used instead.

callback is called with three arguments: the value of the element, the index of the element, and the object being traversed.

filter does not directly mutate the object on which it is called but the object may be mutated by the calls to callback.

The range of elements processed by filter is set before the first call to callback. Elements which are appended to the array after the call to filter begins will not be visited by callback. If existing elements of the array are changed their value as passed to callback will be the value at the time filter visits them; elements that are deleted after the call to filter begins and before being visited are not visited.

This method performs the following steps when called:

  1. Let O be ? ToObject(this value).
  2. Let len be ? LengthOfArrayLike(O).
  3. If IsCallable(callback) is false, throw a TypeError exception.
  4. Let A be ? ArraySpeciesCreate(O, 0).
  5. Let k be 0.
  6. Let to be 0.
  7. Repeat, while k < len,
    1. Let Pk be ! ToString(𝔽(k)).
    2. Let kPresent be ? HasProperty(O, Pk).
    3. If kPresent is true, then
      1. Let kValue be ? Get(O, Pk).
      2. Let selected be ToBoolean(? Call(callback, thisArg, « kValue, 𝔽(k), O »)).
      3. If selected is true, then
        1. Perform ? CreateDataPropertyOrThrow(A, ! ToString(𝔽(to)), kValue).
        2. Set to to to + 1.
    4. Set k to k + 1.
  8. Return A.
Note 2

This method is intentionally generic; it does not require that its this value be an Array. Therefore it can be transferred to other kinds of objects for use as a method.

23.1.3.9 Array.prototype.find ( predicate [ , thisArg ] )

Note 1

This method calls predicate once for each element of the array, in ascending index order, until it finds one where predicate returns a value that coerces to true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

See FindViaPredicate for additional information.

This method performs the following steps when called:

  1. Let O be ? ToObject(this value).
  2. Let len be ? LengthOfArrayLike(O).
  3. Let findRec be ? FindViaPredicate(O, len, ascending, predicate, thisArg).
  4. Return findRec.[[Value]].
Note 2

This method is intentionally generic; it does not require that its this value be an Array. Therefore it can be transferred to other kinds of objects for use as a method.

23.1.3.10 Array.prototype.findIndex ( predicate [ , thisArg ] )

Note 1

This method calls predicate once for each element of the array, in ascending index order, until it finds one where predicate returns a value that coerces to true. If such an element is found, findIndex immediately returns the index of that element value. Otherwise, findIndex returns -1.

See FindViaPredicate for additional information.

This method performs the following steps when called:

  1. Let O be ? ToObject(this value).
  2. Let len be ? LengthOfArrayLike(O).
  3. Let findRec be ? FindViaPredicate(O, len, ascending, predicate, thisArg).
  4. Return findRec.[[Index]].
Note 2

This method is intentionally generic; it does not require that its this value be an Array. Therefore it can be transferred to other kinds of objects for use as a method.

23.1.3.11 Array.prototype.findLast ( predicate [ , thisArg ] )

Note 1

This method calls predicate once for each element of the array, in descending index order, until it finds one where predicate returns a value that coerces to true. If such an element is found, findLast immediately returns that element value. Otherwise, findLast returns undefined.

See FindViaPredicate for additional information.

This method performs the following steps when called:

  1. Let O be ? ToObject(this value).
  2. Let len be ? LengthOfArrayLike(O).
  3. Let findRec be ? FindViaPredicate(O, len, descending, predicate, thisArg).
  4. Return findRec.[[Value]].
Note 2

This method is intentionally generic; it does not require that its this value be an Array object. Therefore it can be transferred to other kinds of objects for use as a method.

23.1.3.12 Array.prototype.findLastIndex ( predicate [ , thisArg ] )

Note 1

This method calls predicate once for each element of the array, in descending index order, until it finds one where predicate returns a value that coerces to true. If such an element is found, findLastIndex immediately returns the index of that element value. Otherwise, findLastIndex returns -1.

See FindViaPredicate for additional information.

This method performs the following steps when called:

  1. Let O be ? ToObject(this value).
  2. Let len be ? LengthOfArrayLike(O).
  3. Let findRec be ? FindViaPredicate(O, len, descending, predicate, thisArg).
  4. Return findRec.[[Index]].
Note 2

This method is intentionally generic; it does not require that its this value be an Array object. Therefore it can be transferred to other kinds of objects for use as a method.

23.1.3.12.1 FindViaPredicate ( O, len, direction, predicate, thisArg )

The abstract operation FindViaPredicate takes arguments O (an Object), len (a non-negative integer), direction (ascending or descending), predicate (an ECMAScript language value), and thisArg (an ECMAScript language value) and returns either a normal completion containing a Record with fields [[Index]] (an integral Number) and [[Value]] (an ECMAScript language value) or a throw completion.

O should be an array-like object or a TypedArray. This operation calls predicate once for each element of O, in either ascending index order or descending index order (as indicated by direction), until it finds one where predicate returns a value that coerces to true. At that point, this operation returns a Record that gives the index and value of the element found. If no such element is found, this operation returns a Record that specifies -1𝔽 for the index and undefined for the value.

predicate should be a function. When called for an element of the array, it is passed three arguments: the value of the element, the index of the element, and the object being traversed. Its return value will be coerced to a Boolean value.

thisArg will be used as the this value for each invocation of predicate.

This operation does not directly mutate the object on which it is called, but the object may be mutated by the calls to predicate.

The range of elements processed is set before the first call to predicate, just before the traversal begins. Elements that are appended to the array after this will not be visited by predicate. If existing elements of the array are changed, their value as passed to predicate will be the value at the time that this operation visits them. Elements that are deleted after traversal begins and before being visited are still visited and are either looked up from the prototype or are undefined.

It performs the following steps when called:

  1. If IsCallable(predicate) is false, throw a TypeError exception.
  2. If direction is ascending, then
    1. Let indices be a List of the integers in the interval from 0 (inclusive) to len (exclusive), in ascending order.
  3. Else,
    1. Let indices be a List of the integers in the interval from 0 (inclusive) to len (exclusive), in descending order.
  4. For each integer k of indices, do
    1. Let Pk be ! ToString(𝔽(k)).
    2. NOTE: If O is a TypedArray, the following invocation of Get will return a normal completion.
    3. Let kValue be ? Get(O, Pk).
    4. Let testResult be ? Call(predicate, thisArg, « kValue, 𝔽(k), O »).
    5. If ToBoolean(testResult) is true, return the Record { [[Index]]: 𝔽(k), [[Value]]: kValue }.
  5. Return the Record { [[Index]]: -1𝔽, [[Value]]: undefined }.

23.1.3.13 Array.prototype.flat ( [ depth ] )

This method performs the following steps when called:

  1. Let O be ? ToObject(this value).
  2. Let sourceLen be ? LengthOfArrayLike(O).
  3. Let depthNum be 1.
  4. If depth is not undefined, then
    1. Set depthNum to ? ToIntegerOrInfinity(depth).
    2. If depthNum < 0, set depthNum to 0.
  5. Let A be ? ArraySpeciesCreate(O, 0).
  6. Perform ? FlattenIntoArray(A, O, sourceLen, 0, depthNum).
  7. Return A.

23.1.3.13.1 FlattenIntoArray ( target, source, sourceLen, start, depth [ , mapperFunction [ , thisArg ] ] )

The abstract operation FlattenIntoArray takes arguments target (an Object), source (an Object), sourceLen (a non-negative integer), start (a non-negative integer), and depth (a non-negative integer or +∞) and optional arguments mapperFunction (a function object) and thisArg (an ECMAScript language value) and returns either a normal completion containing a non-negative integer or a throw completion. It performs the following steps when called:

  1. Assert: If mapperFunction is present, then IsCallable(mapperFunction) is true, thisArg is present, and depth is 1.
  2. Let targetIndex be start.
  3. Let sourceIndex be +0𝔽.
  4. Repeat, while (sourceIndex) < sourceLen,
    1. Let P be ! ToString(sourceIndex).
    2. Let exists be ? HasProperty(source, P).
    3. If exists is true, then
      1. Let element be ? Get(source, P).
      2. If mapperFunction is present, then
        1. Set element to ? Call(mapperFunction, thisArg, « element, sourceIndex, source »).
      3. Let shouldFlatten be false.
      4. If depth > 0, then
        1. Set shouldFlatten to ? IsArray(element).
      5. If shouldFlatten is true, then
        1. If depth = +∞, let newDepth be +∞.
        2. Else, let newDepth be depth - 1.
        3. Let elementLen be ? LengthOfArrayLike(element).
        4. Set targetIndex to ? FlattenIntoArray(target, element, elementLen, targetIndex, newDepth).
      6. Else,
        1. If targetIndex ≥ 253 - 1, throw a TypeError exception.
        2. Perform ? CreateDataPropertyOrThrow(target, ! ToString(𝔽(targetIndex)), element).
        3. Set targetIndex to targetIndex + 1.
    4. Set sourceIndex to sourceIndex + 1𝔽.
  5. Return targetIndex.

23.1.3.14 Array.prototype.flatMap ( mapperFunction [ , thisArg ] )

This method performs the following steps when called:

  1. Let O be ? ToObject(this value).
  2. Let sourceLen be ? LengthOfArrayLike(O).
  3. If IsCallable(mapperFunction) is false, throw a TypeError exception.
  4. Let A be ? ArraySpeciesCreate(O, 0).
  5. Perform ? FlattenIntoArray(A, O, sourceLen, 0, 1, mapperFunction, thisArg).
  6. Return A.

23.1.3.15 Array.prototype.forEach ( callback [ , thisArg ] )

Note 1

callback should be a function that accepts three arguments. forEach calls callback once for each element present in the array, in ascending order. callback is called only for elements of the array which actually exist; it is not called for missing elements of the array.

If a thisArg parameter is provided, it will be used as the this value for each invocation of callback. If it is not provided, undefined is used instead.

callback is called with three arguments: the value of the element, the index of the element, and the object being traversed.

forEach does not directly mutate the object on which it is called but the object may be mutated by the calls to callback.

The range of elements processed by forEach is set before the first call to callback. Elements which are appended to the array after the call to forEach begins will not be visited by callback. If existing elements of the array are changed, their value as passed to callback will be the value at the time forEach visits them; elements that are deleted after the call to forEach begins and before being visited are not visited.

This method performs the following steps when called:

  1. Let O be ? ToObject(this value).
  2. Let len be ? LengthOfArrayLike(O).
  3. If IsCallable(callback) is false, throw a TypeError exception.
  4. Let k be 0.
  5. Repeat, while k < len,
    1. Let Pk be ! ToString(𝔽(k)).
    2. Let kPresent be ? HasProperty(O, Pk).
    3. If kPresent is true, then
      1. Let kValue be ? Get(O, Pk).
      2. Perform ? Call(callback, thisArg, « kValue, 𝔽(k), O »).
    4. Set k to k + 1.
  6. Return undefined.
Note 2

This method is intentionally generic; it does not require that its this value be an Array. Therefore it can be transferred to other kinds of objects for use as a method.

23.1.3.16 Array.prototype.includes ( searchElement [ , fromIndex ] )

Note 1

This method compares searchElement to the elements of the array, in ascending order, using the SameValueZero algorithm, and if found at any position, returns true; otherwise, it returns false.

The optional second argument fromIndex defaults to +0𝔽 (i.e. the whole array is searched). If it is greater than or equal to the length of the array, false is returned, i.e. the array will not be searched. If it is less than -0𝔽, it is used as the offset from the end of the array to compute fromIndex. If the computed index is less than or equal to +0𝔽, the whole array will be searched.

This method performs the following steps when called:

  1. Let O be ? ToObject(this value).
  2. Let len be ? LengthOfArrayLike(O).
  3. If len = 0, return false.
  4. Let n be ? ToIntegerOrInfinity(fromIndex).
  5. Assert: If fromIndex is undefined, then n is 0.
  6. If n = +∞, return false.
  7. Else if n = -∞, set n to 0.
  8. If n ≥ 0, then
    1. Let k be n.
  9. Else,
    1. Let k be len + n.
    2. If k < 0, set k to 0.
  10. Repeat, while k < len,
    1. Let elementK be ? Get(O, ! ToString(𝔽(k))).
    2. If SameValueZero(searchElement, elementK) is true, return true.
    3. Set k to k + 1.
  11. Return false.
Note 2

This method is intentionally generic; it does not require that its this value be an Array. Therefore it can be transferred to other kinds of objects for use as a method.

Note 3

This method intentionally differs from the similar indexOf method in two ways. First, it uses the SameValueZero algorithm, instead of IsStrictlyEqual, allowing it to detect NaN array elements. Second, it does not skip missing array elements, instead treating them as undefined.

23.1.3.17 Array.prototype.indexOf ( searchElement [ , fromIndex ] )

This method compares searchElement to the elements of the array, in ascending order, using the IsStrictlyEqual algorithm, and if found at one or more indices, returns the smallest such index; otherwise, it returns -1𝔽.

Note 1

The optional second argument fromIndex defaults to +0𝔽 (i.e. the whole array is searched). If it is greater than or equal to the length of the array, -1𝔽 is returned, i.e. the array will not be searched. If it is less than -0𝔽, it is used as the offset from the end of the array to compute fromIndex. If the computed index is less than or equal to +0𝔽, the whole array will be searched.

This method performs the following steps when called:

  1. Let O be ? ToObject(this value).
  2. Let len be ? LengthOfArrayLike(O).
  3. If len = 0, return -1𝔽.
  4. Let n be ? ToIntegerOrInfinity(fromIndex).
  5. Assert: If fromIndex is undefined, then n is 0.
  6. If n = +∞, return -1𝔽.
  7. Else if n = -∞, set n to 0.
  8. If n ≥ 0, then
    1. Let k be n.
  9. Else,
    1. Let k be len + n.
    2. If k < 0, set k to 0.
  10. Repeat, while k < len,
    1. Let Pk be ! ToString(𝔽(k)).
    2. Let kPresent be ? HasProperty(O, Pk).
    3. If kPresent is true, then
      1. Let elementK be ? Get(O, Pk).
      2. If IsStrictlyEqual(searchElement, elementK) is true, return 𝔽(k).
    4. Set k to k + 1.
  11. Return -1𝔽.
Note 2

This method is intentionally generic; it does not require that its this value be an Array. Therefore it can be transferred to other kinds of objects for use as a method.

23.1.3.18 Array.prototype.join ( separator )

This method converts the elements of the array to Strings, and then concatenates these Strings, separated by occurrences of the separator. If no separator is provided, a single comma is used as the separator.

It performs the following steps when called:

  1. Let O be ? ToObject(this value).
  2. Let len be ? LengthOfArrayLike(O).
  3. If separator is undefined, let sep be ",".
  4. Else, let sep be ? ToString(separator).
  5. Let R be the empty String.
  6. Let k be 0.
  7. Repeat, while k < len,
    1. If k > 0, set R to the string-concatenation of R and sep.
    2. Let element be ? Get(O, ! ToString(𝔽(k))).
    3. If element is neither undefined nor null, then
      1. Let S be ? ToString(element).
      2. Set R to the string-concatenation of R and S.
    4. Set k to k + 1.
  8. Return R.
Note

This method is intentionally generic; it does not require that its this value be an Array. Therefore, it can be transferred to other kinds of objects for use as a method.

23.1.3.19 Array.prototype.keys ( )

This method performs the following steps when called:

  1. Let O be ? ToObject(this value).
  2. Return CreateArrayIterator(O, key).

23.1.3.20 Array.prototype.lastIndexOf ( searchElement [ , fromIndex ] )

Note 1

This method compares searchElement to the elements of the array in descending order using the IsStrictlyEqual algorithm, and if found at one or more indices, returns the largest such index; otherwise, it returns -1𝔽.

The optional second argument fromIndex defaults to the array's length minus one (i.e. the whole array is searched). If it is greater than or equal to the length of the array, the whole array will be searched. If it is less than -0𝔽, it is used as the offset from the end of the array to compute fromIndex. If the computed index is less than or equal to +0𝔽, -1𝔽 is returned.

This method performs the following steps when called:

  1. Let O be ? ToObject(this value).
  2. Let len be ? LengthOfArrayLike(O).
  3. If len = 0, return -1𝔽.
  4. If fromIndex is present, let n be ? ToIntegerOrInfinity(fromIndex); else let n be len - 1.
  5. If n = -∞, return -1𝔽.
  6. If n ≥ 0, then
    1. Let k be min(n, len - 1).
  7. Else,
    1. Let k be len + n.
  8. Repeat, while k ≥ 0,
    1. Let Pk be ! ToString(𝔽(k)).
    2. Let kPresent be ? HasProperty(O, Pk).
    3. If kPresent is true, then
      1. Let elementK be ? Get(O, Pk).
      2. If IsStrictlyEqual(searchElement, elementK) is true, return 𝔽(k).
    4. Set k to k - 1.
  9. Return -1𝔽.
Note 2

This method is intentionally generic; it does not require that its this value be an Array. Therefore it can be transferred to other kinds of objects for use as a method.

23.1.3.21 Array.prototype.map ( callback [ , thisArg ] )

Note 1

callback should be a function that accepts three arguments. map calls callback once for each element in the array, in ascending order, and constructs a new Array from the results. callback is called only for elements of the array which actually exist; it is not called for missing elements of the array.

If a thisArg parameter is provided, it will be used as the this value for each invocation of callback. If it is not provided, undefined is used instead.

callback is called with three arguments: the value of the element, the index of the element, and the object being traversed.

map does not directly mutate the object on which it is called but the object may be mutated by the calls to callback.

The range of elements processed by map is set before the first call to callback. Elements which are appended to the array after the call to map begins will not be visited by callback. If existing elements of the array are changed, their value as passed to callback will be the value at the time map visits them; elements that are deleted after the call to map begins and before being visited are not visited.

This method performs the following steps when called:

  1. Let O be ? ToObject(this value).
  2. Let len be ? LengthOfArrayLike(O).
  3. If IsCallable(callback) is false, throw a TypeError exception.
  4. Let A be ? ArraySpeciesCreate(O, len).
  5. Let k be 0.
  6. Repeat, while k < len,
    1. Let Pk be ! ToString(𝔽(k)).
    2. Let kPresent be ? HasProperty(O, Pk).
    3. If kPresent is true, then
      1. Let kValue be ? Get(O, Pk).
      2. Let mappedValue be ? Call(callback, thisArg, « kValue, 𝔽(k), O »).
      3. Perform ? CreateDataPropertyOrThrow(A, Pk, mappedValue).
    4. Set k to k + 1.
  7. Return A.
Note 2

This method is intentionally generic; it does not require that its this value be an Array. Therefore it can be transferred to other kinds of objects for use as a method.

23.1.3.22 Array.prototype.pop ( )

Note 1

This method removes the last element of the array and returns it.

This method performs the following steps when called:

  1. Let O be ? ToObject(this value).
  2. Let len be ? LengthOfArrayLike(O).
  3. If len = 0, then
    1. Perform ? Set(O, "length", +0𝔽, true).
    2. Return undefined.
  4. Else,
    1. Assert: len > 0.
    2. Let newLen be 𝔽(len - 1).
    3. Let index be ! ToString(newLen).
    4. Let element be ? Get(O, index).
    5. Perform ? DeletePropertyOrThrow(O, index).
    6. Perform ? Set(O, "length", newLen, true).
    7. Return element.
Note 2

This method is intentionally generic; it does not require that its this value be an Array. Therefore it can be transferred to other kinds of objects for use as a method.

23.1.3.23 Array.prototype.push ( ...items )

Note 1

This method appends the arguments to the end of the array, in the order in which they appear. It returns the new length of the array.

This method performs the following steps when called:

  1. Let O be ? ToObject(this value).
  2. Let len be ? LengthOfArrayLike(O).
  3. Let argCount be the number of elements in items.
  4. If len + argCount > 253 - 1, throw a TypeError exception.
  5. For each element E of items, do
    1. Perform ? Set(O, ! ToString(𝔽(len)), E, true).
    2. Set len to len + 1.
  6. Perform ? Set(O, "length", 𝔽(len), true).
  7. Return 𝔽(len).

The "length" property of this method is 1𝔽.

Note 2

This method is intentionally generic; it does not require that its this value be an Array. Therefore it can be transferred to other kinds of objects for use as a method.

23.1.3.24 Array.prototype.reduce ( callback [ , initialValue ] )

Note 1

callback should be a function that takes four arguments. reduce calls the callback, as a function, once for each element after the first element present in the array, in ascending order.

callback is called with four arguments: the previousValue (value from the previous call to callback), the currentValue (value of the current element), the currentIndex, and the object being traversed. The first time that callback is called, the previousValue and currentValue can be one of two values. If an initialValue was supplied in the call to reduce, then previousValue will be initialValue and currentValue will be the first value in the array. If no initialValue was supplied, then previousValue will be the first value in the array and currentValue will be the second. It is a TypeError if the array contains no elements and initialValue is not provided.

reduce does not directly mutate the object on which it is called but the object may be mutated by the calls to callback.

The range of elements processed by reduce is set before the first call to callback. Elements that are appended to the array after the call to reduce begins will not be visited by callback. If existing elements of the array are changed, their value as passed to callback will be the value at the time reduce visits them; elements that are deleted after the call to reduce begins and before being visited are not visited.

This method performs the following steps when called:

  1. Let O be ? ToObject(this value).
  2. Let len be ? LengthOfArrayLike(O).
  3. If IsCallable(callback) is false, throw a TypeError exception.
  4. If len = 0 and initialValue is not present, throw a TypeError exception.
  5. Let k be 0.
  6. Let accumulator be undefined.
  7. If initialValue is present, then
    1. Set accumulator to initialValue.
  8. Else,
    1. Let kPresent be false.
    2. Repeat, while kPresent is false and k < len,
      1. Let Pk be ! ToString(𝔽(k)).
      2. Set kPresent to ? HasProperty(O, Pk).
      3. If kPresent is true, then
        1. Set accumulator to ? Get(O, Pk).
      4. Set k to k + 1.
    3. If kPresent is false, throw a TypeError exception.
  9. Repeat, while k < len,
    1. Let Pk be ! ToString(𝔽(k)).
    2. Let kPresent be ? HasProperty(O, Pk).
    3. If kPresent is true, then
      1. Let kValue be ? Get(O, Pk).
      2. Set accumulator to ? Call(callback, undefined, « accumulator, kValue, 𝔽(k), O »).
    4. Set k to k + 1.
  10. Return accumulator.
Note 2

This method is intentionally generic; it does not require that its this value be an Array. Therefore it can be transferred to other kinds of objects for use as a method.

23.1.3.25 Array.prototype.reduceRight ( callback [ , initialValue ] )

Note 1

callback should be a function that takes four arguments. reduceRight calls the callback, as a function, once for each element after the first element present in the array, in descending order.

callback is called with four arguments: the previousValue (value from the previous call to callback), the currentValue (value of the current element), the currentIndex, and the object being traversed. The first time the function is called, the previousValue and currentValue can be one of two values. If an initialValue was supplied in the call to reduceRight, then previousValue will be initialValue and currentValue will be the last value in the array. If no initialValue was supplied, then previousValue will be the last value in the array and currentValue will be the second-to-last value. It is a TypeError if the array contains no elements and initialValue is not provided.

reduceRight does not directly mutate the object on which it is called but the object may be mutated by the calls to callback.

The range of elements processed by reduceRight is set before the first call to callback. Elements that are appended to the array after the call to reduceRight begins will not be visited by callback. If existing elements of the array are changed by callback, their value as passed to callback will be the value at the time reduceRight visits them; elements that are deleted after the call to reduceRight begins and before being visited are not visited.

This method performs the following steps when called:

  1. Let O be ? ToObject(this value).
  2. Let len be ? LengthOfArrayLike(O).
  3. If IsCallable(callback) is false, throw a TypeError exception.
  4. If len = 0 and initialValue is not present, throw a TypeError exception.
  5. Let k be len - 1.
  6. Let accumulator be undefined.
  7. If initialValue is present, then
    1. Set accumulator to initialValue.
  8. Else,
    1. Let kPresent be false.
    2. Repeat, while kPresent is false and k ≥ 0,
      1. Let Pk be ! ToString(𝔽(k)).
      2. Set kPresent to ? HasProperty(O, Pk).
      3. If kPresent is true, then
        1. Set accumulator to ? Get(O, Pk).
      4. Set k to k - 1.
    3. If kPresent is false, throw a TypeError exception.
  9. Repeat, while k ≥ 0,
    1. Let Pk be ! ToString(𝔽(k)).
    2. Let kPresent be ? HasProperty(O, Pk).
    3. If kPresent is true, then
      1. Let kValue be ? Get(O, Pk).
      2. Set accumulator to ? Call(callback, undefined, « accumulator, kValue, 𝔽(k), O »).
    4. Set k to k - 1.
  10. Return accumulator.
Note 2

This method is intentionally generic; it does not require that its this value be an Array. Therefore it can be transferred to other kinds of objects for use as a method.

23.1.3.26 Array.prototype.reverse ( )

Note 1

This method rearranges the elements of the array so as to reverse their order. It returns the reversed array.

This method performs the following steps when called:

  1. Let O be ? ToObject(this value).
  2. Let len be ? LengthOfArrayLike(O).
  3. Let middle be floor(len / 2).
  4. Let lower be 0.
  5. Repeat, while lowermiddle,
    1. Let upper be len - lower - 1.
    2. Let upperP be ! ToString(𝔽(upper)).
    3. Let lowerP be ! ToString(𝔽(lower)).
    4. Let lowerExists be ? HasProperty(O, lowerP).
    5. If lowerExists is true, then
      1. Let lowerValue be ? Get(O, lowerP).
    6. Let upperExists be ? HasProperty(O, upperP).
    7. If upperExists is true, then
      1. Let upperValue be ? Get(O, upperP).
    8. If lowerExists is true and upperExists is true, then
      1. Perform ? Set(O, lowerP, upperValue, true).
      2. Perform ? Set(O, upperP, lowerValue, true).
    9. Else if lowerExists is false and upperExists is true, then
      1. Perform ? Set(O, lowerP, upperValue, true).
      2. Perform ? DeletePropertyOrThrow(O, upperP).
    10. Else if lowerExists is true and upperExists is false, then
      1. Perform ? DeletePropertyOrThrow(O, lowerP).
      2. Perform ? Set(O, upperP, lowerValue, true).
    11. Else,
      1. Assert: lowerExists and upperExists are both false.
      2. NOTE: No action is required.
    12. Set lower to lower + 1.
  6. Return O.
Note 2

This method is intentionally generic; it does not require that its this value be an Array. Therefore, it can be transferred to other kinds of objects for use as a method.

23.1.3.27 Array.prototype.shift ( )

This method removes the first element of the array and returns it.

It performs the following steps when called:

  1. Let O be ? ToObject(this value).
  2. Let len be ? LengthOfArrayLike(O).
  3. If len = 0, then
    1. Perform ? Set(O, "length", +0𝔽, true).
    2. Return undefined.
  4. Let first be ? Get(O, "0").
  5. Let k be 1.
  6. Repeat, while k < len,
    1. Let from be ! ToString(𝔽(k)).
    2. Let to be ! ToString(𝔽(k - 1)).
    3. Let fromPresent be ? HasProperty(O, from).
    4. If fromPresent is true, then
      1. Let fromValue be ? Get(O, from).
      2. Perform ? Set(O, to, fromValue, true).
    5. Else,
      1. Assert: fromPresent is false.
      2. Perform ? DeletePropertyOrThrow(O, to).
    6. Set k to k + 1.
  7. Perform ? DeletePropertyOrThrow(O, ! ToString(𝔽(len - 1))).
  8. Perform ? Set(O, "length", 𝔽(len - 1), true).
  9. Return first.
Note

This method is intentionally generic; it does not require that its this value be an Array. Therefore it can be transferred to other kinds of objects for use as a method.

23.1.3.28 Array.prototype.slice ( start, end )

This method returns an array containing the elements of the array from element start up to, but not including, element end (or through the end of the array if end is undefined). If start is negative, it is treated as length + start where length is the length of the array. If end is negative, it is treated as length + end where length is the length of the array.

It performs the following steps when called:

  1. Let O be ? ToObject(this value).
  2. Let len be ? LengthOfArrayLike(O).
  3. Let relativeStart be ? ToIntegerOrInfinity(start).
  4. If relativeStart = -∞, let k be 0.
  5. Else if relativeStart < 0, let k be max(len + relativeStart, 0).
  6. Else, let k be min(relativeStart, len).
  7. If end is undefined, let relativeEnd be len; else let relativeEnd be ? ToIntegerOrInfinity(end).
  8. If relativeEnd = -∞, let final be 0.
  9. Else if relativeEnd < 0, let final be max(len + relativeEnd, 0).
  10. Else, let final be min(relativeEnd, len).
  11. Let count be max(final - k, 0).
  12. Let A be ? ArraySpeciesCreate(O, count).
  13. Let n be 0.
  14. Repeat, while k < final,
    1. Let Pk be ! ToString(𝔽(k)).
    2. Let kPresent be ? HasProperty(O, Pk).
    3. If kPresent is true, then
      1. Let kValue be ? Get(O, Pk).
      2. Perform ? CreateDataPropertyOrThrow(A, ! ToString(𝔽(n)), kValue).
    4. Set k to k + 1.
    5. Set n to n + 1.
  15. Perform ? Set(A, "length", 𝔽(n), true).
  16. Return A.
Note 1

The explicit setting of the "length" property in step 15 is intended to ensure the length is correct even when A is not a built-in Array.

Note 2

This method is intentionally generic; it does not require that its this value be an Array. Therefore it can be transferred to other kinds of objects for use as a method.

23.1.3.29 Array.prototype.some ( callback [ , thisArg ] )

Note 1

callback should be a function that accepts three arguments and returns a value that is coercible to a Boolean value. some calls callback once for each element present in the array, in ascending order, until it finds one where callback returns true. If such an element is found, some immediately returns true. Otherwise, some returns false. callback is called only for elements of the array which actually exist; it is not called for missing elements of the array.

If a thisArg parameter is provided, it will be used as the this value for each invocation of callback. If it is not provided, undefined is used instead.

callback is called with three arguments: the value of the element, the index of the element, and the object being traversed.

some does not directly mutate the object on which it is called but the object may be mutated by the calls to callback.

The range of elements processed by some is set before the first call to callback. Elements that are appended to the array after the call to some begins will not be visited by callback. If existing elements of the array are changed, their value as passed to callback will be the value at the time that some visits them; elements that are deleted after the call to some begins and before being visited are not visited. some acts like the "exists" quantifier in mathematics. In particular, for an empty array, it returns false.

This method performs the following steps when called:

  1. Let O be ? ToObject(this value).
  2. Let len be ? LengthOfArrayLike(O).
  3. If IsCallable(callback) is false, throw a TypeError exception.
  4. Let k be 0.
  5. Repeat, while k < len,
    1. Let Pk be ! ToString(𝔽(k)).
    2. Let kPresent be ? HasProperty(O, Pk).
    3. If kPresent is true, then
      1. Let kValue be ? Get(O, Pk).
      2. Let testResult be ToBoolean(? Call(callback, thisArg, « kValue, 𝔽(k), O »)).
      3. If testResult is true, return true.
    4. Set k to k + 1.
  6. Return false.
Note 2

This method is intentionally generic; it does not require that its this value be an Array. Therefore it can be transferred to other kinds of objects for use as a method.

23.1.3.30 Array.prototype.sort ( comparator )

This method sorts the elements of this array. If comparator is not undefined, it should be a function that accepts two arguments x and y and returns a negative Number if x < y, a positive Number if x > y, or a zero otherwise.

It performs the following steps when called:

  1. If comparator is not undefined and IsCallable(comparator) is false, throw a TypeError exception.
  2. Let obj be ? ToObject(this value).
  3. Let len be ? LengthOfArrayLike(obj).
  4. Let SortCompare be a new Abstract Closure with parameters (x, y) that captures comparator and performs the following steps when called:
    1. Return ? CompareArrayElements(x, y, comparator).
  5. Let sortedList be ? SortIndexedProperties(obj, len, SortCompare, skip-holes).
  6. Let itemCount be the number of elements in sortedList.
  7. Let j be 0.
  8. Repeat, while j < itemCount,
    1. Perform ? Set(obj, ! ToString(𝔽(j)), sortedList[j], true).
    2. Set j to j + 1.
  9. NOTE: The call to SortIndexedProperties in step 5 uses skip-holes. The remaining indices are deleted to preserve the number of holes that were detected and excluded from the sort.
  10. Repeat, while j < len,
    1. Perform ? DeletePropertyOrThrow(obj, ! ToString(𝔽(j))).
    2. Set j to j + 1.
  11. Return obj.
Note 1

Because non-existent property values always compare greater than undefined property values, and undefined always compares greater than any other value (see CompareArrayElements), undefined property values always sort to the end of the result, followed by non-existent property values.

Note 2

Method calls performed by the ToString abstract operations in steps 5 and 6 have the potential to cause SortCompare to not behave as a consistent comparator.

Note 3

This method is intentionally generic; it does not require that its this value be an Array. Therefore, it can be transferred to other kinds of objects for use as a method.

23.1.3.30.1 SortIndexedProperties ( obj, len, SortCompare, holes )

The abstract operation SortIndexedProperties takes arguments obj (an Object), len (a non-negative integer), SortCompare (an Abstract Closure with two parameters), and holes (skip-holes or read-through-holes) and returns either a normal completion containing a List of ECMAScript language values or a throw completion. It performs the following steps when called:

  1. Let items be a new empty List.
  2. Let k be 0.
  3. Repeat, while k < len,
    1. Let Pk be ! ToString(𝔽(k)).
    2. If holes is skip-holes, then
      1. Let kRead be ? HasProperty(obj, Pk).
    3. Else,
      1. Assert: holes is read-through-holes.
      2. Let kRead be true.
    4. If kRead is true, then
      1. Let kValue be ? Get(obj, Pk).
      2. Append kValue to items.
    5. Set k to k + 1.
  4. Sort items using an implementation-defined sequence of calls to SortCompare. If any such call returns an abrupt completion, stop before performing any further calls to SortCompare and return that Completion Record.
  5. Return items.

The sort order is the ordering of items after completion of step 4 of the algorithm above. The sort order is implementation-defined if SortCompare is not a consistent comparator for the elements of items. When SortIndexedProperties is invoked by Array.prototype.sort or Array.prototype.toSorted, the sort order is also implementation-defined if comparator is undefined, and all applications of ToString, to any specific value passed as an argument to SortCompare, do not produce the same result.

Unless the sort order is specified to be implementation-defined, it must satisfy all of the following conditions:

  • There must be some mathematical permutation π of the non-negative integers less than itemCount, such that for every non-negative integer j less than itemCount, the element old[j] is exactly the same as new[π(j)].
  • Then for all non-negative integers j and k, each less than itemCount, if (SortCompare(old[j], old[k])) < 0, then π(j) < π(k).
  • And for all non-negative integers j and k such that j < k < itemCount, if (SortCompare(old[j], old[k])) = 0, then π(j) < π(k); i.e., the sort is stable.

Here the notation old[j] is used to refer to items[j] before step 4 is executed, and the notation new[j] to refer to items[j] after step 4 has been executed.

An abstract closure or function comparator is a consistent comparator for a set of values S if all of the requirements below are met for all values a, b, and c (possibly the same value) in the set S: The notation a <C b means (comparator(a, b)) < 0; a =C b means (comparator(a, b)) = 0; and a >C b means (comparator(a, b)) > 0.

  • Calling comparator(a, b) always returns the same value v when given a specific pair of values a and b as its two arguments. Furthermore, v is a Number, and v is not NaN. Note that this implies that exactly one of a <C b, a =C b, and a >C b will be true for a given pair of a and b.
  • Calling comparator(a, b) does not modify obj or any object on obj's prototype chain.
  • a =C a (reflexivity)
  • If a =C b, then b =C a (symmetry)
  • If a =C b and b =C c, then a =C c (transitivity of =C)
  • If a <C b and b <C c, then a <C c (transitivity of <C)
  • If a >C b and b >C c, then a >C c (transitivity of >C)
Note

The above conditions are necessary and sufficient to ensure that comparator divides the set S into equivalence classes and that these equivalence classes are totally ordered.

23.1.3.30.2 CompareArrayElements ( x, y, comparator )

The abstract operation CompareArrayElements takes arguments x (an ECMAScript language value), y (an ECMAScript language value), and comparator (a function object or undefined) and returns either a normal completion containing a Number or an abrupt completion. It performs the following steps when called:

  1. If x and y are both undefined, return +0𝔽.
  2. If x is undefined, return 1𝔽.
  3. If y is undefined, return -1𝔽.
  4. If comparator is not undefined, then
    1. Let v be ? ToNumber(? Call(comparator, undefined, « x, y »)).
    2. If v is NaN, return +0𝔽.
    3. Return v.
  5. Let xString be ? ToString(x).
  6. Let yString be ? ToString(y).
  7. Let xSmaller be ! IsLessThan(xString, yString, true).
  8. If xSmaller is true, return -1𝔽.
  9. Let ySmaller be ! IsLessThan(yString, xString, true).
  10. If ySmaller is true, return 1𝔽.
  11. Return +0𝔽.

23.1.3.31 Array.prototype.splice ( start, deleteCount, ...items )

Note 1

This method deletes the deleteCount elements of the array starting at integer index start and replaces them with the elements of items. It returns an Array containing the deleted elements (if any).

This method performs the following steps when called:

  1. Let O be ? ToObject(this value).
  2. Let len be ? LengthOfArrayLike(O).
  3. Let relativeStart be ? ToIntegerOrInfinity(start).
  4. If relativeStart = -∞, let actualStart be 0.
  5. Else if relativeStart < 0, let actualStart be max(len + relativeStart, 0).
  6. Else, let actualStart be min(relativeStart, len).
  7. Let itemCount be the number of elements in items.
  8. If start is not present, then
    1. Let actualDeleteCount be 0.
  9. Else if deleteCount is not present, then
    1. Let actualDeleteCount be len - actualStart.
  10. Else,
    1. Let dc be ? ToIntegerOrInfinity(deleteCount).
    2. Let actualDeleteCount be the result of clamping dc between 0 and len - actualStart.
  11. If len + itemCount - actualDeleteCount > 253 - 1, throw a TypeError exception.
  12. Let A be ? ArraySpeciesCreate(O, actualDeleteCount).
  13. Let k be 0.
  14. Repeat, while k < actualDeleteCount,
    1. Let from be ! ToString(𝔽(actualStart + k)).
    2. If ? HasProperty(O, from) is true, then
      1. Let fromValue be ? Get(O, from).
      2. Perform ? CreateDataPropertyOrThrow(A, ! ToString(𝔽(k)), fromValue).
    3. Set k to k + 1.
  15. Perform ? Set(A, "length", 𝔽(actualDeleteCount), true).
  16. If itemCount < actualDeleteCount, then
    1. Set k to actualStart.
    2. Repeat, while k < (len - actualDeleteCount),
      1. Let from be ! ToString(𝔽(k + actualDeleteCount)).
      2. Let to be ! ToString(𝔽(k + itemCount)).
      3. If ? HasProperty(O, from) is true, then
        1. Let fromValue be ? Get(O, from).
        2. Perform ? Set(O, to, fromValue, true).
      4. Else,
        1. Perform ? DeletePropertyOrThrow(O, to).
      5. Set k to k + 1.
    3. Set k to len.
    4. Repeat, while k > (len - actualDeleteCount + itemCount),
      1. Perform ? DeletePropertyOrThrow(O, ! ToString(𝔽(k - 1))).
      2. Set k to k - 1.
  17. Else if itemCount > actualDeleteCount, then
    1. Set k to (len - actualDeleteCount).
    2. Repeat, while k > actualStart,
      1. Let from be ! ToString(𝔽(k + actualDeleteCount - 1)).
      2. Let to be ! ToString(𝔽(k + itemCount - 1)).
      3. If ? HasProperty(O, from) is true, then
        1. Let fromValue be ? Get(O, from).
        2. Perform ? Set(O, to, fromValue, true).
      4. Else,
        1. Perform ? DeletePropertyOrThrow(O, to).
      5. Set k to k - 1.
  18. Set k to actualStart.
  19. For each element E of items, do
    1. Perform ? Set(O, ! ToString(𝔽(k)), E, true).
    2. Set k to k + 1.
  20. Perform ? Set(O, "length", 𝔽(len - actualDeleteCount + itemCount), true).
  21. Return A.
Note 2

The explicit setting of the "length" property in steps 15 and 20 is intended to ensure the lengths are correct even when the objects are not built-in Arrays.

Note 3

This method is intentionally generic; it does not require that its this value be an Array. Therefore it can be transferred to other kinds of objects for use as a method.

23.1.3.32 Array.prototype.toLocaleString ( [ reserved1 [ , reserved2 ] ] )

An ECMAScript implementation that includes the ECMA-402 Internationalization API must implement this method as specified in the ECMA-402 specification. If an ECMAScript implementation does not include the ECMA-402 API the following specification of this method is used.

Note 1

The first edition of ECMA-402 did not include a replacement specification for this method.

The meanings of the optional parameters to this method are defined in the ECMA-402 specification; implementations that do not include ECMA-402 support must not use those parameter positions for anything else.

This method performs the following steps when called:

  1. Let array be ? ToObject(this value).
  2. Let len be ? LengthOfArrayLike(array).
  3. Let separator be the implementation-defined list-separator String value appropriate for the host environment's current locale (such as ", ").
  4. Let R be the empty String.
  5. Let k be 0.
  6. Repeat, while k < len,
    1. If k > 0, set R to the string-concatenation of R and separator.
    2. Let element be ? Get(array, ! ToString(𝔽(k))).
    3. If element is neither undefined nor null, then
      1. Let S be ? ToString(? Invoke(element, "toLocaleString")).
      2. Set R to the string-concatenation of R and S.
    4. Set k to k + 1.
  7. Return R.
Note 2

This method converts the elements of the array to Strings using their toLocaleString methods, and then concatenates these Strings, separated by occurrences of an implementation-defined locale-sensitive separator String. This method is analogous to toString except that it is intended to yield a locale-sensitive result corresponding with conventions of the host environment's current locale.

Note 3

This method is intentionally generic; it does not require that its this value be an Array. Therefore it can be transferred to other kinds of objects for use as a method.

23.1.3.33 Array.prototype.toReversed ( )

This method performs the following steps when called:

  1. Let O be ? ToObject(this value).
  2. Let len be ? LengthOfArrayLike(O).
  3. Let A be ? ArrayCreate(len).
  4. Let k be 0.
  5. Repeat, while k < len,
    1. Let from be ! ToString(𝔽(len - k - 1)).
    2. Let Pk be ! ToString(𝔽(k)).
    3. Let fromValue be ? Get(O, from).
    4. Perform ! CreateDataPropertyOrThrow(A, Pk, fromValue).
    5. Set k to k + 1.
  6. Return A.

23.1.3.34 Array.prototype.toSorted ( comparator )

This method performs the following steps when called:

  1. If comparator is not undefined and IsCallable(comparator) is false, throw a TypeError exception.
  2. Let O be ? ToObject(this value).
  3. Let len be ? LengthOfArrayLike(O).
  4. Let A be ? ArrayCreate(len).
  5. Let SortCompare be a new Abstract Closure with parameters (x, y) that captures comparator and performs the following steps when called:
    1. Return ? CompareArrayElements(x, y, comparator).
  6. Let sortedList be ? SortIndexedProperties(O, len, SortCompare, read-through-holes).
  7. Let j be 0.
  8. Repeat, while j < len,
    1. Perform ! CreateDataPropertyOrThrow(A, ! ToString(𝔽(j)), sortedList[j]).
    2. Set j to j + 1.
  9. Return A.

23.1.3.35 Array.prototype.toSpliced ( start, skipCount, ...items )

This method performs the following steps when called:

  1. Let O be ? ToObject(this value).
  2. Let len be ? LengthOfArrayLike(O).
  3. Let relativeStart be ? ToIntegerOrInfinity(start).
  4. If relativeStart = -∞, let actualStart be 0.
  5. Else if relativeStart < 0, let actualStart be max(len + relativeStart, 0).
  6. Else, let actualStart be min(relativeStart, len).
  7. Let insertCount be the number of elements in items.
  8. If start is not present, then
    1. Let actualSkipCount be 0.
  9. Else if skipCount is not present, then
    1. Let actualSkipCount be len - actualStart.
  10. Else,
    1. Let sc be ? ToIntegerOrInfinity(skipCount).
    2. Let actualSkipCount be the result of clamping sc between 0 and len - actualStart.
  11. Let newLen be len + insertCount - actualSkipCount.
  12. If newLen > 253 - 1, throw a TypeError exception.
  13. Let A be ? ArrayCreate(newLen).
  14. Let i be 0.
  15. Let r be actualStart + actualSkipCount.
  16. Repeat, while i < actualStart,
    1. Let Pi be ! ToString(𝔽(i)).
    2. Let iValue be ? Get(O, Pi).
    3. Perform ! CreateDataPropertyOrThrow(A, Pi, iValue).
    4. Set i to i + 1.
  17. For each element E of items, do
    1. Let Pi be ! ToString(𝔽(i)).
    2. Perform ! CreateDataPropertyOrThrow(A, Pi, E).
    3. Set i to i + 1.
  18. Repeat, while i < newLen,
    1. Let Pi be ! ToString(𝔽(i)).
    2. Let from be ! ToString(𝔽(r)).
    3. Let fromValue be ? Get(O, from).
    4. Perform ! CreateDataPropertyOrThrow(A, Pi, fromValue).
    5. Set i to i + 1.
    6. Set r to r + 1.
  19. Return A.

23.1.3.36 Array.prototype.toString ( )

This method performs the following steps when called:

  1. Let array be ? ToObject(this value).
  2. Let func be ? Get(array, "join").
  3. If IsCallable(func) is false, set func to the intrinsic function %Object.prototype.toString%.
  4. Return ? Call(func, array).
Note

This method is intentionally generic; it does not require that its this value be an Array. Therefore it can be transferred to other kinds of objects for use as a method.

23.1.3.37 Array.prototype.unshift ( ...items )

This method prepends the arguments to the start of the array, such that their order within the array is the same as the order in which they appear in the argument list.

It performs the following steps when called:

  1. Let O be ? ToObject(this value).
  2. Let len be ? LengthOfArrayLike(O).
  3. Let argCount be the number of elements in items.
  4. If argCount > 0, then
    1. If len + argCount > 253 - 1, throw a TypeError exception.
    2. Let k be len.
    3. Repeat, while k > 0,
      1. Let from be ! ToString(𝔽(k - 1)).
      2. Let to be ! ToString(𝔽(k + argCount - 1)).
      3. Let fromPresent be ? HasProperty(O, from).
      4. If fromPresent is true, then
        1. Let fromValue be ? Get(O, from).
        2. Perform ? Set(O, to, fromValue, true).
      5. Else,
        1. Assert: fromPresent is false.
        2. Perform ? DeletePropertyOrThrow(O, to).
      6. Set k to k - 1.
    4. Let j be +0𝔽.
    5. For each element E of items, do
      1. Perform ? Set(O, ! ToString(j), E, true).
      2. Set j to j + 1𝔽.
  5. Perform ? Set(O, "length", 𝔽(len + argCount), true).
  6. Return 𝔽(len + argCount).

The "length" property of this method is 1𝔽.

Note

This method is intentionally generic; it does not require that its this value be an Array. Therefore it can be transferred to other kinds of objects for use as a method.

23.1.3.38 Array.prototype.values ( )

This method performs the following steps when called:

  1. Let O be ? ToObject(this value).
  2. Return CreateArrayIterator(O, value).

23.1.3.39 Array.prototype.with ( index, value )

This method performs the following steps when called:

  1. Let O be ? ToObject(this value).
  2. Let len be ? LengthOfArrayLike(O).
  3. Let relativeIndex be ? ToIntegerOrInfinity(index).
  4. If relativeIndex ≥ 0, let actualIndex be relativeIndex.
  5. Else, let actualIndex be len + relativeIndex.
  6. If actualIndexlen or actualIndex < 0, throw a RangeError exception.
  7. Let A be ? ArrayCreate(len).
  8. Let k be 0.
  9. Repeat, while k < len,
    1. Let Pk be ! ToString(𝔽(k)).
    2. If k = actualIndex, let fromValue be value.
    3. Else, let fromValue be ? Get(O, Pk).
    4. Perform ! CreateDataPropertyOrThrow(A, Pk, fromValue).
    5. Set k to k + 1.
  10. Return A.

23.1.3.40 Array.prototype [ %Symbol.iterator% ] ( )

The initial value of the %Symbol.iterator% property is %Array.prototype.values%, defined in 23.1.3.38.

23.1.3.41 Array.prototype [ %Symbol.unscopables% ]

The initial value of the %Symbol.unscopables% data property is an object created by the following steps:

  1. Let unscopableList be OrdinaryObjectCreate(null).
  2. Perform ! CreateDataPropertyOrThrow(unscopableList, "at", true).
  3. Perform ! CreateDataPropertyOrThrow(unscopableList, "copyWithin", true).
  4. Perform ! CreateDataPropertyOrThrow(unscopableList, "entries", true).
  5. Perform ! CreateDataPropertyOrThrow(unscopableList, "fill", true).
  6. Perform ! CreateDataPropertyOrThrow(unscopableList, "find", true).
  7. Perform ! CreateDataPropertyOrThrow(unscopableList, "findIndex", true).
  8. Perform ! CreateDataPropertyOrThrow(unscopableList, "findLast", true).
  9. Perform ! CreateDataPropertyOrThrow(unscopableList, "findLastIndex", true).
  10. Perform ! CreateDataPropertyOrThrow(unscopableList, "flat", true).
  11. Perform ! CreateDataPropertyOrThrow(unscopableList, "flatMap", true).
  12. Perform ! CreateDataPropertyOrThrow(unscopableList, "includes", true).
  13. Perform ! CreateDataPropertyOrThrow(unscopableList, "keys", true).
  14. Perform ! CreateDataPropertyOrThrow(unscopableList, "toReversed", true).
  15. Perform ! CreateDataPropertyOrThrow(unscopableList, "toSorted", true).
  16. Perform ! CreateDataPropertyOrThrow(unscopableList, "toSpliced", true).
  17. Perform ! CreateDataPropertyOrThrow(unscopableList, "values", true).
  18. Return unscopableList.

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: true }.

Note

The own property names of this object are property names that were not included as standard properties of Array.prototype prior to the ECMAScript 2015 specification. These names are ignored for with statement binding purposes in order to preserve the behaviour of existing code that might use one of these names as a binding in an outer scope that is shadowed by a with statement whose binding object is an Array.

The reason that "with" is not included in the unscopableList is because it is already a reserved word.

23.1.4 Properties of Array Instances

Array instances are Array exotic objects and have the internal methods specified for such objects. Array instances inherit properties from the Array prototype object.

Array instances have a "length" property, and a set of enumerable properties with array index names.

23.1.4.1 length

The "length" property of an Array instance is a data property whose value is always numerically greater than the name of every configurable own property whose name is an array index.

The "length" property initially has the attributes { [[Writable]]: true, [[Enumerable]]: false, [[Configurable]]: false }.

Note

Reducing the value of the "length" property has the side-effect of deleting own array elements whose array index is between the old and new length values. However, non-configurable properties can not be deleted. Attempting to set the "length" property of an Array to a value that is numerically less than or equal to the largest numeric own property name of an existing non-configurable array-indexed property of the array will result in the length being set to a numeric value that is one greater than that non-configurable numeric own property name. See 10.4.2.1.

23.1.5 Array Iterator Objects

An Array Iterator is an object that represents a specific iteration over some specific Array instance object. There is not a named constructor for Array Iterator objects. Instead, Array Iterator objects are created by calling certain methods of Array instance objects.

23.1.5.1 CreateArrayIterator ( array, kind )

The abstract operation CreateArrayIterator takes arguments array (an Object) and kind (key+value, key, or value) and returns an Object. It is used to create iterator objects for Array methods that return such iterators. It performs the following steps when called:

  1. Let iterator be OrdinaryObjectCreate(%ArrayIteratorPrototype%, « [[IteratedArrayLike]], [[ArrayLikeNextIndex]], [[ArrayLikeIterationKind]] »).
  2. Set iterator.[[IteratedArrayLike]] to array.
  3. Set iterator.[[ArrayLikeNextIndex]] to 0.
  4. Set iterator.[[ArrayLikeIterationKind]] to kind.
  5. Return iterator.

23.1.5.2 The %ArrayIteratorPrototype% Object

The %ArrayIteratorPrototype% object:

23.1.5.2.1 %ArrayIteratorPrototype%.next ( )

  1. Let O be the this value.
  2. If O is not an Object, throw a TypeError exception.
  3. If O does not have all of the internal slots of an Array Iterator Instance (23.1.5.3), throw a TypeError exception.
  4. Let array be O.[[IteratedArrayLike]].
  5. If array is undefined, return CreateIteratorResultObject(undefined, true).
  6. Let index be O.[[ArrayLikeNextIndex]].
  7. Let kind be O.[[ArrayLikeIterationKind]].
  8. If array has a [[TypedArrayName]] internal slot, then
    1. Let taRecord be MakeTypedArrayWithBufferWitnessRecord(array, seq-cst).
    2. If IsTypedArrayOutOfBounds(taRecord) is true, throw a TypeError exception.
    3. Let len be TypedArrayLength(taRecord).
  9. Else,
    1. Let len be ? LengthOfArrayLike(array).
  10. If indexlen, then
    1. Set O.[[IteratedArrayLike]] to undefined.
    2. Return CreateIteratorResultObject(undefined, true).
  11. Set O.[[ArrayLikeNextIndex]] to index + 1.
  12. Let indexNumber be 𝔽(index).
  13. If kind is key, then
    1. Let result be indexNumber.
  14. Else,
    1. Let elementKey be ! ToString(indexNumber).
    2. Let elementValue be ? Get(array, elementKey).
    3. If kind is value, then
      1. Let result be elementValue.
    4. Else,
      1. Assert: kind is key+value.
      2. Let result be CreateArrayFromListindexNumber, elementValue »).
  15. Return CreateIteratorResultObject(result, false).

23.1.5.2.2 %ArrayIteratorPrototype% [ %Symbol.toStringTag% ]

The initial value of the %Symbol.toStringTag% property is the String value "Array Iterator".

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: true }.

23.1.5.3 Properties of Array Iterator Instances

Array Iterator instances are ordinary objects that inherit properties from the %ArrayIteratorPrototype% intrinsic object. Array Iterator instances are initially created with the internal slots listed in Table 74.

Table 74: Internal Slots of Array Iterator Instances
Internal Slot Type Description
[[IteratedArrayLike]] an Object or undefined The array-like object that is being iterated.
[[ArrayLikeNextIndex]] a non-negative integer The integer index of the next element to be examined by this iterator.
[[ArrayLikeIterationKind]] key+value, key, or value A value that identifies what is returned for each element of the iteration.

23.2 TypedArray Objects

A TypedArray presents an array-like view of an underlying binary data buffer (25.1). A TypedArray element type is the underlying binary scalar data type that all elements of a TypedArray instance have. There is a distinct TypedArray constructor, listed in Table 75, for each of the supported element types. Each constructor in Table 75 has a corresponding distinct prototype object.

Table 75: The TypedArray Constructors
Constructor Name and Intrinsic Element Type Element Size Conversion Operation Description
Int8Array
%Int8Array%
int8 1 ToInt8 8-bit two's complement signed integer
Uint8Array
%Uint8Array%
uint8 1 ToUint8 8-bit unsigned integer
Uint8ClampedArray
%Uint8ClampedArray%
uint8clamped 1 ToUint8Clamp 8-bit unsigned integer (clamped conversion)
Int16Array
%Int16Array%
int16 2 ToInt16 16-bit two's complement signed integer
Uint16Array
%Uint16Array%
uint16 2 ToUint16 16-bit unsigned integer
Int32Array
%Int32Array%
int32 4 ToInt32 32-bit two's complement signed integer
Uint32Array
%Uint32Array%
uint32 4 ToUint32 32-bit unsigned integer
BigInt64Array
%BigInt64Array%
bigint64 8 ToBigInt64 64-bit two's complement signed integer
BigUint64Array
%BigUint64Array%
biguint64 8 ToBigUint64 64-bit unsigned integer
Float16Array
%Float16Array%
float16 2 16-bit IEEE floating point
Float32Array
%Float32Array%
float32 4 32-bit IEEE floating point
Float64Array
%Float64Array%
float64 8 64-bit IEEE floating point

In the definitions below, references to TypedArray should be replaced with the appropriate constructor name from the above table.

23.2.1 The %TypedArray% Intrinsic Object

The %TypedArray% intrinsic object:

  • is a constructor function object that all of the TypedArray constructor objects inherit from.
  • along with its corresponding prototype object, provides common properties that are inherited by all TypedArray constructors and their instances.
  • does not have a global name or appear as a property of the global object.
  • acts as the abstract superclass of the various TypedArray constructors.
  • will throw an error when invoked, because it is an abstract class constructor. The TypedArray constructors do not perform a super call to it.

23.2.1.1 %TypedArray% ( )

This function performs the following steps when called:

  1. Throw a TypeError exception.

The "length" property of this function is +0𝔽.

23.2.2 Properties of the %TypedArray% Intrinsic Object

The %TypedArray% intrinsic object:

  • has a [[Prototype]] internal slot whose value is %Function.prototype%.
  • has a "name" property whose value is "TypedArray".
  • has the following properties:

23.2.2.1 %TypedArray%.from ( source [ , mapper [ , thisArg ] ] )

This method performs the following steps when called:

  1. Let C be the this value.
  2. If IsConstructor(C) is false, throw a TypeError exception.
  3. If mapper is undefined, then
    1. Let mapping be false.
  4. Else,
    1. If IsCallable(mapper) is false, throw a TypeError exception.
    2. Let mapping be true.
  5. Let usingIterator be ? GetMethod(source, %Symbol.iterator%).
  6. If usingIterator is not undefined, then
    1. Let values be ? IteratorToList(? GetIteratorFromMethod(source, usingIterator)).
    2. Let len be the number of elements in values.
    3. Let targetObj be ? TypedArrayCreateFromConstructor(C, « 𝔽(len) »).
    4. Let k be 0.
    5. Repeat, while k < len,
      1. Let Pk be ! ToString(𝔽(k)).
      2. Let kValue be the first element of values.
      3. Remove the first element from values.
      4. If mapping is true, then
        1. Let mappedValue be ? Call(mapper, thisArg, « kValue, 𝔽(k) »).
      5. Else,
        1. Let mappedValue be kValue.
      6. Perform ? Set(targetObj, Pk, mappedValue, true).
      7. Set k to k + 1.
    6. Assert: values is now an empty List.
    7. Return targetObj.
  7. NOTE: source is not an iterable object, so assume it is already an array-like object.
  8. Let arrayLike be ! ToObject(source).
  9. Let len be ? LengthOfArrayLike(arrayLike).
  10. Let targetObj be ? TypedArrayCreateFromConstructor(C, « 𝔽(len) »).
  11. Let k be 0.
  12. Repeat, while k < len,
    1. Let Pk be ! ToString(𝔽(k)).
    2. Let kValue be ? Get(arrayLike, Pk).
    3. If mapping is true, then
      1. Let mappedValue be ? Call(mapper, thisArg, « kValue, 𝔽(k) »).
    4. Else,
      1. Let mappedValue be kValue.
    5. Perform ? Set(targetObj, Pk, mappedValue, true).
    6. Set k to k + 1.
  13. Return targetObj.

23.2.2.2 %TypedArray%.of ( ...items )

This method performs the following steps when called:

  1. Let len be the number of elements in items.
  2. Let C be the this value.
  3. If IsConstructor(C) is false, throw a TypeError exception.
  4. Let newObj be ? TypedArrayCreateFromConstructor(C, « 𝔽(len) »).
  5. Let k be 0.
  6. Repeat, while k < len,
    1. Let kValue be items[k].
    2. Let Pk be ! ToString(𝔽(k)).
    3. Perform ? Set(newObj, Pk, kValue, true).
    4. Set k to k + 1.
  7. Return newObj.

23.2.2.3 %TypedArray%.prototype

The initial value of %TypedArray%.prototype is the %TypedArray% prototype object.

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: false }.

23.2.2.4 get %TypedArray% [ %Symbol.species% ]

%TypedArray%[%Symbol.species%] is an accessor property whose set accessor function is undefined. Its get accessor function performs the following steps when called:

  1. Return the this value.

The value of the "name" property of this function is "get [Symbol.species]".

Note

%TypedArray.prototype% methods normally use their this value's constructor to create a derived object. However, a subclass constructor may over-ride that default behaviour by redefining its %Symbol.species% property.

23.2.3 Properties of the %TypedArray% Prototype Object

The %TypedArray% prototype object:

  • has a [[Prototype]] internal slot whose value is %Object.prototype%.
  • is %TypedArray.prototype%.
  • is an ordinary object.
  • does not have a [[ViewedArrayBuffer]] or any other of the internal slots that are specific to TypedArray instance objects.

23.2.3.1 %TypedArray%.prototype.at ( index )

  1. Let O be the this value.
  2. Let taRecord be ? ValidateTypedArray(O, seq-cst).
  3. Let len be TypedArrayLength(taRecord).
  4. Let relativeIndex be ? ToIntegerOrInfinity(index).
  5. If relativeIndex ≥ 0, then
    1. Let k be relativeIndex.
  6. Else,
    1. Let k be len + relativeIndex.
  7. If k < 0 or klen, return undefined.
  8. Return ! Get(O, ! ToString(𝔽(k))).

23.2.3.2 get %TypedArray%.prototype.buffer

%TypedArray%.prototype.buffer is an accessor property whose set accessor function is undefined. Its get accessor function performs the following steps when called:

  1. Let O be the this value.
  2. Perform ? RequireInternalSlot(O, [[TypedArrayName]]).
  3. Assert: O has a [[ViewedArrayBuffer]] internal slot.
  4. Let buffer be O.[[ViewedArrayBuffer]].
  5. Return buffer.

23.2.3.3 get %TypedArray%.prototype.byteLength

%TypedArray%.prototype.byteLength is an accessor property whose set accessor function is undefined. Its get accessor function performs the following steps when called:

  1. Let O be the this value.
  2. Perform ? RequireInternalSlot(O, [[TypedArrayName]]).
  3. Assert: O has a [[ViewedArrayBuffer]] internal slot.
  4. Let taRecord be MakeTypedArrayWithBufferWitnessRecord(O, seq-cst).
  5. Let size be TypedArrayByteLength(taRecord).
  6. Return 𝔽(size).

23.2.3.4 get %TypedArray%.prototype.byteOffset

%TypedArray%.prototype.byteOffset is an accessor property whose set accessor function is undefined. Its get accessor function performs the following steps when called:

  1. Let O be the this value.
  2. Perform ? RequireInternalSlot(O, [[TypedArrayName]]).
  3. Assert: O has a [[ViewedArrayBuffer]] internal slot.
  4. Let taRecord be MakeTypedArrayWithBufferWitnessRecord(O, seq-cst).
  5. If IsTypedArrayOutOfBounds(taRecord) is true, return +0𝔽.
  6. Let offset be O.[[ByteOffset]].
  7. Return 𝔽(offset).

23.2.3.5 %TypedArray%.prototype.constructor

The initial value of %TypedArray%.prototype.constructor is %TypedArray%.

23.2.3.6 %TypedArray%.prototype.copyWithin ( target, start [ , end ] )

The interpretation and use of the arguments of this method are the same as for Array.prototype.copyWithin as defined in 23.1.3.4.

This method performs the following steps when called:

  1. Let O be the this value.
  2. Let taRecord be ? ValidateTypedArray(O, seq-cst).
  3. Let len be TypedArrayLength(taRecord).
  4. Let relativeTarget be ? ToIntegerOrInfinity(target).
  5. If relativeTarget = -∞, let targetIndex be 0.
  6. Else if relativeTarget < 0, let targetIndex be max(len + relativeTarget, 0).
  7. Else, let targetIndex be min(relativeTarget, len).
  8. Let relativeStart be ? ToIntegerOrInfinity(start).
  9. If relativeStart = -∞, let startIndex be 0.
  10. Else if relativeStart < 0, let startIndex be max(len + relativeStart, 0).
  11. Else, let startIndex be min(relativeStart, len).
  12. If end is undefined, let relativeEnd be len; else let relativeEnd be ? ToIntegerOrInfinity(end).
  13. If relativeEnd = -∞, let endIndex be 0.
  14. Else if relativeEnd < 0, let endIndex be max(len + relativeEnd, 0).
  15. Else, let endIndex be min(relativeEnd, len).
  16. Let count be min(endIndex - startIndex, len - targetIndex).
  17. If count > 0, then
    1. NOTE: The copying must be performed in a manner that preserves the bit-level encoding of the source data.
    2. Let buffer be O.[[ViewedArrayBuffer]].
    3. Set taRecord to MakeTypedArrayWithBufferWitnessRecord(O, seq-cst).
    4. If IsTypedArrayOutOfBounds(taRecord) is true, throw a TypeError exception.
    5. Set len to TypedArrayLength(taRecord).
    6. Let elementSize be TypedArrayElementSize(O).
    7. Let byteOffset be O.[[ByteOffset]].
    8. Let bufferByteLimit be (len × elementSize) + byteOffset.
    9. Let toByteIndex be (targetIndex × elementSize) + byteOffset.
    10. Let fromByteIndex be (startIndex × elementSize) + byteOffset.
    11. Let countBytes be count × elementSize.
    12. If fromByteIndex < toByteIndex and toByteIndex < fromByteIndex + countBytes, then
      1. Let direction be -1.
      2. Set fromByteIndex to fromByteIndex + countBytes - 1.
      3. Set toByteIndex to toByteIndex + countBytes - 1.
    13. Else,
      1. Let direction be 1.
    14. Repeat, while countBytes > 0,
      1. If fromByteIndex < bufferByteLimit and toByteIndex < bufferByteLimit, then
        1. Let value be GetValueFromBuffer(buffer, fromByteIndex, uint8, true, unordered).
        2. Perform SetValueInBuffer(buffer, toByteIndex, uint8, value, true, unordered).
        3. Set fromByteIndex to fromByteIndex + direction.
        4. Set toByteIndex to toByteIndex + direction.
        5. Set countBytes to countBytes - 1.
      2. Else,
        1. Set countBytes to 0.
  18. Return O.

23.2.3.7 %TypedArray%.prototype.entries ( )

This method performs the following steps when called:

  1. Let O be the this value.
  2. Perform ? ValidateTypedArray(O, seq-cst).
  3. Return CreateArrayIterator(O, key+value).

23.2.3.8 %TypedArray%.prototype.every ( callback [ , thisArg ] )

The interpretation and use of the arguments of this method are the same as for Array.prototype.every as defined in 23.1.3.6.

This method performs the following steps when called:

  1. Let O be the this value.
  2. Let taRecord be ? ValidateTypedArray(O, seq-cst).
  3. Let len be TypedArrayLength(taRecord).
  4. If IsCallable(callback) is false, throw a TypeError exception.
  5. Let k be 0.
  6. Repeat, while k < len,
    1. Let Pk be ! ToString(𝔽(k)).
    2. Let kValue be ! Get(O, Pk).
    3. Let testResult be ToBoolean(? Call(callback, thisArg, « kValue, 𝔽(k), O »)).
    4. If testResult is false, return false.
    5. Set k to k + 1.
  7. Return true.

This method is not generic. The this value must be an object with a [[TypedArrayName]] internal slot.

23.2.3.9 %TypedArray%.prototype.fill ( value [ , start [ , end ] ] )

The interpretation and use of the arguments of this method are the same as for Array.prototype.fill as defined in 23.1.3.7.

This method performs the following steps when called:

  1. Let O be the this value.
  2. Let taRecord be ? ValidateTypedArray(O, seq-cst).
  3. Let len be TypedArrayLength(taRecord).
  4. If O.[[ContentType]] is bigint, set value to ? ToBigInt(value).
  5. Otherwise, set value to ? ToNumber(value).
  6. Let relativeStart be ? ToIntegerOrInfinity(start).
  7. If relativeStart = -∞, let startIndex be 0.
  8. Else if relativeStart < 0, let startIndex be max(len + relativeStart, 0).
  9. Else, let startIndex be min(relativeStart, len).
  10. If end is undefined, let relativeEnd be len; else let relativeEnd be ? ToIntegerOrInfinity(end).
  11. If relativeEnd = -∞, let endIndex be 0.
  12. Else if relativeEnd < 0, let endIndex be max(len + relativeEnd, 0).
  13. Else, let endIndex be min(relativeEnd, len).
  14. Set taRecord to MakeTypedArrayWithBufferWitnessRecord(O, seq-cst).
  15. If IsTypedArrayOutOfBounds(taRecord) is true, throw a TypeError exception.
  16. Set len to TypedArrayLength(taRecord).
  17. Set endIndex to min(endIndex, len).
  18. Let k be startIndex.
  19. Repeat, while k < endIndex,
    1. Let Pk be ! ToString(𝔽(k)).
    2. Perform ! Set(O, Pk, value, true).
    3. Set k to k + 1.
  20. Return O.

23.2.3.10 %TypedArray%.prototype.filter ( callback [ , thisArg ] )

The interpretation and use of the arguments of this method are the same as for Array.prototype.filter as defined in 23.1.3.8.

This method performs the following steps when called:

  1. Let O be the this value.
  2. Let taRecord be ? ValidateTypedArray(O, seq-cst).
  3. Let len be TypedArrayLength(taRecord).
  4. If IsCallable(callback) is false, throw a TypeError exception.
  5. Let kept be a new empty List.
  6. Let captured be 0.
  7. Let k be 0.
  8. Repeat, while k < len,
    1. Let Pk be ! ToString(𝔽(k)).
    2. Let kValue be ! Get(O, Pk).
    3. Let selected be ToBoolean(? Call(callback, thisArg, « kValue, 𝔽(k), O »)).
    4. If selected is true, then
      1. Append kValue to kept.
      2. Set captured to captured + 1.
    5. Set k to k + 1.
  9. Let A be ? TypedArraySpeciesCreate(O, « 𝔽(captured) »).
  10. Let n be 0.
  11. For each element e of kept, do
    1. Perform ! Set(A, ! ToString(𝔽(n)), e, true).
    2. Set n to n + 1.
  12. Return A.

This method is not generic. The this value must be an object with a [[TypedArrayName]] internal slot.

23.2.3.11 %TypedArray%.prototype.find ( predicate [ , thisArg ] )

The interpretation and use of the arguments of this method are the same as for Array.prototype.find as defined in 23.1.3.9.

This method performs the following steps when called:

  1. Let O be the this value.
  2. Let taRecord be ? ValidateTypedArray(O, seq-cst).
  3. Let len be TypedArrayLength(taRecord).
  4. Let findRec be ? FindViaPredicate(O, len, ascending, predicate, thisArg).
  5. Return findRec.[[Value]].

This method is not generic. The this value must be an object with a [[TypedArrayName]] internal slot.

23.2.3.12 %TypedArray%.prototype.findIndex ( predicate [ , thisArg ] )

The interpretation and use of the arguments of this method are the same as for Array.prototype.findIndex as defined in 23.1.3.10.

This method performs the following steps when called:

  1. Let O be the this value.
  2. Let taRecord be ? ValidateTypedArray(O, seq-cst).
  3. Let len be TypedArrayLength(taRecord).
  4. Let findRec be ? FindViaPredicate(O, len, ascending, predicate, thisArg).
  5. Return findRec.[[Index]].

This method is not generic. The this value must be an object with a [[TypedArrayName]] internal slot.

23.2.3.13 %TypedArray%.prototype.findLast ( predicate [ , thisArg ] )

The interpretation and use of the arguments of this method are the same as for Array.prototype.findLast as defined in 23.1.3.11.

This method performs the following steps when called:

  1. Let O be the this value.
  2. Let taRecord be ? ValidateTypedArray(O, seq-cst).
  3. Let len be TypedArrayLength(taRecord).
  4. Let findRec be ? FindViaPredicate(O, len, descending, predicate, thisArg).
  5. Return findRec.[[Value]].

This method is not generic. The this value must be an object with a [[TypedArrayName]] internal slot.

23.2.3.14 %TypedArray%.prototype.findLastIndex ( predicate [ , thisArg ] )

The interpretation and use of the arguments of this method are the same as for Array.prototype.findLastIndex as defined in 23.1.3.12.

This method performs the following steps when called:

  1. Let O be the this value.
  2. Let taRecord be ? ValidateTypedArray(O, seq-cst).
  3. Let len be TypedArrayLength(taRecord).
  4. Let findRec be ? FindViaPredicate(O, len, descending, predicate, thisArg).
  5. Return findRec.[[Index]].

This method is not generic. The this value must be an object with a [[TypedArrayName]] internal slot.

23.2.3.15 %TypedArray%.prototype.forEach ( callback [ , thisArg ] )

The interpretation and use of the arguments of this method are the same as for Array.prototype.forEach as defined in 23.1.3.15.

This method performs the following steps when called:

  1. Let O be the this value.
  2. Let taRecord be ? ValidateTypedArray(O, seq-cst).
  3. Let len be TypedArrayLength(taRecord).
  4. If IsCallable(callback) is false, throw a TypeError exception.
  5. Let k be 0.
  6. Repeat, while k < len,
    1. Let Pk be ! ToString(𝔽(k)).
    2. Let kValue be ! Get(O, Pk).
    3. Perform ? Call(callback, thisArg, « kValue, 𝔽(k), O »).
    4. Set k to k + 1.
  7. Return undefined.

This method is not generic. The this value must be an object with a [[TypedArrayName]] internal slot.

23.2.3.16 %TypedArray%.prototype.includes ( searchElement [ , fromIndex ] )

The interpretation and use of the arguments of this method are the same as for Array.prototype.includes as defined in 23.1.3.16.

This method performs the following steps when called:

  1. Let O be the this value.
  2. Let taRecord be ? ValidateTypedArray(O, seq-cst).
  3. Let len be TypedArrayLength(taRecord).
  4. If len = 0, return false.
  5. Let n be ? ToIntegerOrInfinity(fromIndex).
  6. Assert: If fromIndex is undefined, then n is 0.
  7. If n = +∞, return false.
  8. Else if n = -∞, set n to 0.
  9. If n ≥ 0, then
    1. Let k be n.
  10. Else,
    1. Let k be len + n.
    2. If k < 0, set k to 0.
  11. Repeat, while k < len,
    1. Let elementK be ! Get(O, ! ToString(𝔽(k))).
    2. If SameValueZero(searchElement, elementK) is true, return true.
    3. Set k to k + 1.
  12. Return false.

This method is not generic. The this value must be an object with a [[TypedArrayName]] internal slot.

23.2.3.17 %TypedArray%.prototype.indexOf ( searchElement [ , fromIndex ] )

The interpretation and use of the arguments of this method are the same as for Array.prototype.indexOf as defined in 23.1.3.17.

This method performs the following steps when called:

  1. Let O be the this value.
  2. Let taRecord be ? ValidateTypedArray(O, seq-cst).
  3. Let len be TypedArrayLength(taRecord).
  4. If len = 0, return -1𝔽.
  5. Let n be ? ToIntegerOrInfinity(fromIndex).
  6. Assert: If fromIndex is undefined, then n is 0.
  7. If n = +∞, return -1𝔽.
  8. Else if n = -∞, set n to 0.
  9. If n ≥ 0, then
    1. Let k be n.
  10. Else,
    1. Let k be len + n.
    2. If k < 0, set k to 0.
  11. Repeat, while k < len,
    1. Let Pk be ! ToString(𝔽(k)).
    2. Let kPresent be ! HasProperty(O, Pk).
    3. If kPresent is true, then
      1. Let elementK be ! Get(O, Pk).
      2. If IsStrictlyEqual(searchElement, elementK) is true, return 𝔽(k).
    4. Set k to k + 1.
  12. Return -1𝔽.

This method is not generic. The this value must be an object with a [[TypedArrayName]] internal slot.

23.2.3.18 %TypedArray%.prototype.join ( separator )

The interpretation and use of the arguments of this method are the same as for Array.prototype.join as defined in 23.1.3.18.

This method performs the following steps when called:

  1. Let O be the this value.
  2. Let taRecord be ? ValidateTypedArray(O, seq-cst).
  3. Let len be TypedArrayLength(taRecord).
  4. If separator is undefined, let sep be ",".
  5. Else, let sep be ? ToString(separator).
  6. Let R be the empty String.
  7. Let k be 0.
  8. Repeat, while k < len,
    1. If k > 0, set R to the string-concatenation of R and sep.
    2. Let element be ! Get(O, ! ToString(𝔽(k))).
    3. If element is not undefined, then
      1. Let S be ! ToString(element).
      2. Set R to the string-concatenation of R and S.
    4. Set k to k + 1.
  9. Return R.

This method is not generic. The this value must be an object with a [[TypedArrayName]] internal slot.

23.2.3.19 %TypedArray%.prototype.keys ( )

This method performs the following steps when called:

  1. Let O be the this value.
  2. Perform ? ValidateTypedArray(O, seq-cst).
  3. Return CreateArrayIterator(O, key).

23.2.3.20 %TypedArray%.prototype.lastIndexOf ( searchElement [ , fromIndex ] )

The interpretation and use of the arguments of this method are the same as for Array.prototype.lastIndexOf as defined in 23.1.3.20.

This method performs the following steps when called:

  1. Let O be the this value.
  2. Let taRecord be ? ValidateTypedArray(O, seq-cst).
  3. Let len be TypedArrayLength(taRecord).
  4. If len = 0, return -1𝔽.
  5. If fromIndex is present, let n be ? ToIntegerOrInfinity(fromIndex); else let n be len - 1.
  6. If n = -∞, return -1𝔽.
  7. If n ≥ 0, then
    1. Let k be min(n, len - 1).
  8. Else,
    1. Let k be len + n.
  9. Repeat, while k ≥ 0,
    1. Let Pk be ! ToString(𝔽(k)).
    2. Let kPresent be ! HasProperty(O, Pk).
    3. If kPresent is true, then
      1. Let elementK be ! Get(O, Pk).
      2. If IsStrictlyEqual(searchElement, elementK) is true, return 𝔽(k).
    4. Set k to k - 1.
  10. Return -1𝔽.

This method is not generic. The this value must be an object with a [[TypedArrayName]] internal slot.

23.2.3.21 get %TypedArray%.prototype.length

%TypedArray%.prototype.length is an accessor property whose set accessor function is undefined. Its get accessor function performs the following steps when called:

  1. Let O be the this value.
  2. Perform ? RequireInternalSlot(O, [[TypedArrayName]]).
  3. Assert: O has [[ViewedArrayBuffer]] and [[ArrayLength]] internal slots.
  4. Let taRecord be MakeTypedArrayWithBufferWitnessRecord(O, seq-cst).
  5. If IsTypedArrayOutOfBounds(taRecord) is true, return +0𝔽.
  6. Let length be TypedArrayLength(taRecord).
  7. Return 𝔽(length).

This function is not generic. The this value must be an object with a [[TypedArrayName]] internal slot.

23.2.3.22 %TypedArray%.prototype.map ( callback [ , thisArg ] )

The interpretation and use of the arguments of this method are the same as for Array.prototype.map as defined in 23.1.3.21.

This method performs the following steps when called:

  1. Let O be the this value.
  2. Let taRecord be ? ValidateTypedArray(O, seq-cst).
  3. Let len be TypedArrayLength(taRecord).
  4. If IsCallable(callback) is false, throw a TypeError exception.
  5. Let A be ? TypedArraySpeciesCreate(O, « 𝔽(len) »).
  6. Let k be 0.
  7. Repeat, while k < len,
    1. Let Pk be ! ToString(𝔽(k)).
    2. Let kValue be ! Get(O, Pk).
    3. Let mappedValue be ? Call(callback, thisArg, « kValue, 𝔽(k), O »).
    4. Perform ? Set(A, Pk, mappedValue, true).
    5. Set k to k + 1.
  8. Return A.

This method is not generic. The this value must be an object with a [[TypedArrayName]] internal slot.

23.2.3.23 %TypedArray%.prototype.reduce ( callback [ , initialValue ] )

The interpretation and use of the arguments of this method are the same as for Array.prototype.reduce as defined in 23.1.3.24.

This method performs the following steps when called:

  1. Let O be the this value.
  2. Let taRecord be ? ValidateTypedArray(O, seq-cst).
  3. Let len be TypedArrayLength(taRecord).
  4. If IsCallable(callback) is false, throw a TypeError exception.
  5. If len = 0 and initialValue is not present, throw a TypeError exception.
  6. Let k be 0.
  7. Let accumulator be undefined.
  8. If initialValue is present, then
    1. Set accumulator to initialValue.
  9. Else,
    1. Let Pk be ! ToString(𝔽(k)).
    2. Set accumulator to ! Get(O, Pk).
    3. Set k to k + 1.
  10. Repeat, while k < len,
    1. Let Pk be ! ToString(𝔽(k)).
    2. Let kValue be ! Get(O, Pk).
    3. Set accumulator to ? Call(callback, undefined, « accumulator, kValue, 𝔽(k), O »).
    4. Set k to k + 1.
  11. Return accumulator.

This method is not generic. The this value must be an object with a [[TypedArrayName]] internal slot.

23.2.3.24 %TypedArray%.prototype.reduceRight ( callback [ , initialValue ] )

The interpretation and use of the arguments of this method are the same as for Array.prototype.reduceRight as defined in 23.1.3.25.

This method performs the following steps when called:

  1. Let O be the this value.
  2. Let taRecord be ? ValidateTypedArray(O, seq-cst).
  3. Let len be TypedArrayLength(taRecord).
  4. If IsCallable(callback) is false, throw a TypeError exception.
  5. If len = 0 and initialValue is not present, throw a TypeError exception.
  6. Let k be len - 1.
  7. Let accumulator be undefined.
  8. If initialValue is present, then
    1. Set accumulator to initialValue.
  9. Else,
    1. Let Pk be ! ToString(𝔽(k)).
    2. Set accumulator to ! Get(O, Pk).
    3. Set k to k - 1.
  10. Repeat, while k ≥ 0,
    1. Let Pk be ! ToString(𝔽(k)).
    2. Let kValue be ! Get(O, Pk).
    3. Set accumulator to ? Call(callback, undefined, « accumulator, kValue, 𝔽(k), O »).
    4. Set k to k - 1.
  11. Return accumulator.

This method is not generic. The this value must be an object with a [[TypedArrayName]] internal slot.

23.2.3.25 %TypedArray%.prototype.reverse ( )

The interpretation and use of the arguments of this method are the same as for Array.prototype.reverse as defined in 23.1.3.26.

This method performs the following steps when called:

  1. Let O be the this value.
  2. Let taRecord be ? ValidateTypedArray(O, seq-cst).
  3. Let len be TypedArrayLength(taRecord).
  4. Let middle be floor(len / 2).
  5. Let lower be 0.
  6. Repeat, while lowermiddle,
    1. Let upper be len - lower - 1.
    2. Let upperP be ! ToString(𝔽(upper)).
    3. Let lowerP be ! ToString(𝔽(lower)).
    4. Let lowerValue be ! Get(O, lowerP).
    5. Let upperValue be ! Get(O, upperP).
    6. Perform ! Set(O, lowerP, upperValue, true).
    7. Perform ! Set(O, upperP, lowerValue, true).
    8. Set lower to lower + 1.
  7. Return O.

This method is not generic. The this value must be an object with a [[TypedArrayName]] internal slot.

23.2.3.26 %TypedArray%.prototype.set ( source [ , offset ] )

This method sets multiple values in this TypedArray, reading the values from source. The details differ based upon the type of source. The optional offset value indicates the first element index in this TypedArray where values are written. If omitted, it is assumed to be 0.

It performs the following steps when called:

  1. Let target be the this value.
  2. Perform ? RequireInternalSlot(target, [[TypedArrayName]]).
  3. Assert: target has a [[ViewedArrayBuffer]] internal slot.
  4. Let targetOffset be ? ToIntegerOrInfinity(offset).
  5. If targetOffset < 0, throw a RangeError exception.
  6. If source is an Object that has a [[TypedArrayName]] internal slot, then
    1. Perform ? SetTypedArrayFromTypedArray(target, targetOffset, source).
  7. Else,
    1. Perform ? SetTypedArrayFromArrayLike(target, targetOffset, source).
  8. Return undefined.

This method is not generic. The this value must be an object with a [[TypedArrayName]] internal slot.

23.2.3.26.1 SetTypedArrayFromArrayLike ( target, targetOffset, source )

The abstract operation SetTypedArrayFromArrayLike takes arguments target (a TypedArray), targetOffset (a non-negative integer or +∞), and source (an ECMAScript language value, but not a TypedArray) and returns either a normal completion containing unused or a throw completion. It sets multiple values in target, starting at index targetOffset, reading the values from source. It performs the following steps when called:

  1. Let targetRecord be MakeTypedArrayWithBufferWitnessRecord(target, seq-cst).
  2. If IsTypedArrayOutOfBounds(targetRecord) is true, throw a TypeError exception.
  3. Let targetLength be TypedArrayLength(targetRecord).
  4. Let src be ? ToObject(source).
  5. Let srcLength be ? LengthOfArrayLike(src).
  6. If targetOffset = +∞, throw a RangeError exception.
  7. If srcLength + targetOffset > targetLength, throw a RangeError exception.
  8. Let k be 0.
  9. Repeat, while k < srcLength,
    1. Let Pk be ! ToString(𝔽(k)).
    2. Let value be ? Get(src, Pk).
    3. Let targetIndex be 𝔽(targetOffset + k).
    4. Perform ? TypedArraySetElement(target, targetIndex, value).
    5. Set k to k + 1.
  10. Return unused.

23.2.3.26.2 SetTypedArrayFromTypedArray ( target, targetOffset, source )

The abstract operation SetTypedArrayFromTypedArray takes arguments target (a TypedArray), targetOffset (a non-negative integer or +∞), and source (a TypedArray) and returns either a normal completion containing unused or a throw completion. It sets multiple values in target, starting at index targetOffset, reading the values from source. It performs the following steps when called:

  1. Let targetBuffer be target.[[ViewedArrayBuffer]].
  2. Let targetRecord be MakeTypedArrayWithBufferWitnessRecord(target, seq-cst).
  3. If IsTypedArrayOutOfBounds(targetRecord) is true, throw a TypeError exception.
  4. Let targetLength be TypedArrayLength(targetRecord).
  5. Let srcBuffer be source.[[ViewedArrayBuffer]].
  6. Let srcRecord be MakeTypedArrayWithBufferWitnessRecord(source, seq-cst).
  7. If IsTypedArrayOutOfBounds(srcRecord) is true, throw a TypeError exception.
  8. Let srcLength be TypedArrayLength(srcRecord).
  9. Let targetType be TypedArrayElementType(target).
  10. Let targetElementSize be TypedArrayElementSize(target).
  11. Let targetByteOffset be target.[[ByteOffset]].
  12. Let srcType be TypedArrayElementType(source).
  13. Let srcElementSize be TypedArrayElementSize(source).
  14. Let srcByteOffset be source.[[ByteOffset]].
  15. If targetOffset = +∞, throw a RangeError exception.
  16. If srcLength + targetOffset > targetLength, throw a RangeError exception.
  17. If target.[[ContentType]] is not source.[[ContentType]], throw a TypeError exception.
  18. If IsSharedArrayBuffer(srcBuffer) is true, IsSharedArrayBuffer(targetBuffer) is true, and srcBuffer.[[ArrayBufferData]] is targetBuffer.[[ArrayBufferData]], let sameSharedArrayBuffer be true; otherwise let sameSharedArrayBuffer be false.
  19. If SameValue(srcBuffer, targetBuffer) is true or sameSharedArrayBuffer is true, then
    1. Let srcByteLength be TypedArrayByteLength(srcRecord).
    2. Set srcBuffer to ? CloneArrayBuffer(srcBuffer, srcByteOffset, srcByteLength).
    3. Let srcByteIndex be 0.
  20. Else,
    1. Let srcByteIndex be srcByteOffset.
  21. Let targetByteIndex be (targetOffset × targetElementSize) + targetByteOffset.
  22. Let limit be targetByteIndex + (targetElementSize × srcLength).
  23. If srcType is targetType, then
    1. NOTE: The transfer must be performed in a manner that preserves the bit-level encoding of the source data.
    2. Repeat, while targetByteIndex < limit,
      1. Let value be GetValueFromBuffer(srcBuffer, srcByteIndex, uint8, true, unordered).
      2. Perform SetValueInBuffer(targetBuffer, targetByteIndex, uint8, value, true, unordered).
      3. Set srcByteIndex to srcByteIndex + 1.
      4. Set targetByteIndex to targetByteIndex + 1.
  24. Else,
    1. Repeat, while targetByteIndex < limit,
      1. Let value be GetValueFromBuffer(srcBuffer, srcByteIndex, srcType, true, unordered).
      2. Perform SetValueInBuffer(targetBuffer, targetByteIndex, targetType, value, true, unordered).
      3. Set srcByteIndex to srcByteIndex + srcElementSize.
      4. Set targetByteIndex to targetByteIndex + targetElementSize.
  25. Return unused.

23.2.3.27 %TypedArray%.prototype.slice ( start, end )

The interpretation and use of the arguments of this method are the same as for Array.prototype.slice as defined in 23.1.3.28.

This method performs the following steps when called:

  1. Let O be the this value.
  2. Let taRecord be ? ValidateTypedArray(O, seq-cst).
  3. Let srcArrayLength be TypedArrayLength(taRecord).
  4. Let relativeStart be ? ToIntegerOrInfinity(start).
  5. If relativeStart = -∞, let startIndex be 0.
  6. Else if relativeStart < 0, let startIndex be max(srcArrayLength + relativeStart, 0).
  7. Else, let startIndex be min(relativeStart, srcArrayLength).
  8. If end is undefined, let relativeEnd be srcArrayLength; else let relativeEnd be ? ToIntegerOrInfinity(end).
  9. If relativeEnd = -∞, let endIndex be 0.
  10. Else if relativeEnd < 0, let endIndex be max(srcArrayLength + relativeEnd, 0).
  11. Else, let endIndex be min(relativeEnd, srcArrayLength).
  12. Let countBytes be max(endIndex - startIndex, 0).
  13. Let A be ? TypedArraySpeciesCreate(O, « 𝔽(countBytes) »).
  14. If countBytes > 0, then
    1. Set taRecord to MakeTypedArrayWithBufferWitnessRecord(O, seq-cst).
    2. If IsTypedArrayOutOfBounds(taRecord) is true, throw a TypeError exception.
    3. Set endIndex to min(endIndex, TypedArrayLength(taRecord)).
    4. Set countBytes to max(endIndex - startIndex, 0).
    5. Let srcType be TypedArrayElementType(O).
    6. Let targetType be TypedArrayElementType(A).
    7. If srcType is targetType, then
      1. NOTE: The transfer must be performed in a manner that preserves the bit-level encoding of the source data.
      2. Let srcBuffer be O.[[ViewedArrayBuffer]].
      3. Let targetBuffer be A.[[ViewedArrayBuffer]].
      4. Let elementSize be TypedArrayElementSize(O).
      5. Let srcByteOffset be O.[[ByteOffset]].
      6. Let srcByteIndex be (startIndex × elementSize) + srcByteOffset.
      7. Let targetByteIndex be A.[[ByteOffset]].
      8. Let endByteIndex be targetByteIndex + (countBytes × elementSize).
      9. Repeat, while targetByteIndex < endByteIndex,
        1. Let value be GetValueFromBuffer(srcBuffer, srcByteIndex, uint8, true, unordered).
        2. Perform SetValueInBuffer(targetBuffer, targetByteIndex, uint8, value, true, unordered).
        3. Set srcByteIndex to srcByteIndex + 1.
        4. Set targetByteIndex to targetByteIndex + 1.
    8. Else,
      1. Let n be 0.
      2. Let k be startIndex.
      3. Repeat, while k < endIndex,
        1. Let Pk be ! ToString(𝔽(k)).
        2. Let kValue be ! Get(O, Pk).
        3. Perform ! Set(A, ! ToString(𝔽(n)), kValue, true).
        4. Set k to k + 1.
        5. Set n to n + 1.
  15. Return A.

This method is not generic. The this value must be an object with a [[TypedArrayName]] internal slot.

23.2.3.28 %TypedArray%.prototype.some ( callback [ , thisArg ] )

The interpretation and use of the arguments of this method are the same as for Array.prototype.some as defined in 23.1.3.29.

This method performs the following steps when called:

  1. Let O be the this value.
  2. Let taRecord be ? ValidateTypedArray(O, seq-cst).
  3. Let len be TypedArrayLength(taRecord).
  4. If IsCallable(callback) is false, throw a TypeError exception.
  5. Let k be 0.
  6. Repeat, while k < len,
    1. Let Pk be ! ToString(𝔽(k)).
    2. Let kValue be ! Get(O, Pk).
    3. Let testResult be ToBoolean(? Call(callback, thisArg, « kValue, 𝔽(k), O »)).
    4. If testResult is true, return true.
    5. Set k to k + 1.
  7. Return false.

This method is not generic. The this value must be an object with a [[TypedArrayName]] internal slot.

23.2.3.29 %TypedArray%.prototype.sort ( comparator )

This is a distinct method that, except as described below, implements the same requirements as those of Array.prototype.sort as defined in 23.1.3.30. The implementation of this method may be optimized with the knowledge that the this value is an object that has a fixed length and whose integer-indexed properties are not sparse.

This method is not generic. The this value must be an object with a [[TypedArrayName]] internal slot.

It performs the following steps when called:

  1. If comparator is not undefined and IsCallable(comparator) is false, throw a TypeError exception.
  2. Let obj be the this value.
  3. Let taRecord be ? ValidateTypedArray(obj, seq-cst).
  4. Let len be TypedArrayLength(taRecord).
  5. NOTE: The following closure performs a numeric comparison rather than the string comparison used in 23.1.3.30.
  6. Let SortCompare be a new Abstract Closure with parameters (x, y) that captures comparator and performs the following steps when called:
    1. Return ? CompareTypedArrayElements(x, y, comparator).
  7. Let sortedList be ? SortIndexedProperties(obj, len, SortCompare, read-through-holes).
  8. Let j be 0.
  9. Repeat, while j < len,
    1. Perform ! Set(obj, ! ToString(𝔽(j)), sortedList[j], true).
    2. Set j to j + 1.
  10. Return obj.
Note

Because NaN always compares greater than any other value (see CompareTypedArrayElements), NaN property values always sort to the end of the result when comparator is not provided.

23.2.3.30 %TypedArray%.prototype.subarray ( start, end )

This method returns a new TypedArray whose element type is the element type of this TypedArray and whose ArrayBuffer is the ArrayBuffer of this TypedArray, referencing the elements in the interval from start (inclusive) to end (exclusive). If either start or end is negative, it refers to an index from the end of the array, as opposed to from the beginning.

It performs the following steps when called:

  1. Let O be the this value.
  2. Perform ? RequireInternalSlot(O, [[TypedArrayName]]).
  3. Assert: O has a [[ViewedArrayBuffer]] internal slot.
  4. Let buffer be O.[[ViewedArrayBuffer]].
  5. Let srcRecord be MakeTypedArrayWithBufferWitnessRecord(O, seq-cst).
  6. If IsTypedArrayOutOfBounds(srcRecord) is true, then
    1. Let srcLength be 0.
  7. Else,
    1. Let srcLength be TypedArrayLength(srcRecord).
  8. Let relativeStart be ? ToIntegerOrInfinity(start).
  9. If relativeStart = -∞, let startIndex be 0.
  10. Else if relativeStart < 0, let startIndex be max(srcLength + relativeStart, 0).
  11. Else, let startIndex be min(relativeStart, srcLength).
  12. Let elementSize be TypedArrayElementSize(O).
  13. Let srcByteOffset be O.[[ByteOffset]].
  14. Let beginByteOffset be srcByteOffset + (startIndex × elementSize).
  15. If O.[[ArrayLength]] is auto and end is undefined, then
    1. Let argumentsList be « buffer, 𝔽(beginByteOffset) ».
  16. Else,
    1. If end is undefined, let relativeEnd be srcLength; else let relativeEnd be ? ToIntegerOrInfinity(end).
    2. If relativeEnd = -∞, let endIndex be 0.
    3. Else if relativeEnd < 0, let endIndex be max(srcLength + relativeEnd, 0).
    4. Else, let endIndex be min(relativeEnd, srcLength).
    5. Let newLength be max(endIndex - startIndex, 0).
    6. Let argumentsList be « buffer, 𝔽(beginByteOffset), 𝔽(newLength) ».
  17. Return ? TypedArraySpeciesCreate(O, argumentsList).

This method is not generic. The this value must be an object with a [[TypedArrayName]] internal slot.

23.2.3.31 %TypedArray%.prototype.toLocaleString ( [ reserved1 [ , reserved2 ] ] )

This is a distinct method that implements the same algorithm as Array.prototype.toLocaleString as defined in 23.1.3.32 except that TypedArrayLength is called in place of performing a [[Get]] of "length". The implementation of the algorithm may be optimized with the knowledge that the this value has a fixed length when the underlying buffer is not resizable and whose integer-indexed properties are not sparse. However, such optimization must not introduce any observable changes in the specified behaviour of the algorithm.

This method is not generic. ValidateTypedArray is called with the this value and seq-cst as arguments prior to evaluating the algorithm. If its result is an abrupt completion that exception is thrown instead of evaluating the algorithm.

Note

If the ECMAScript implementation includes the ECMA-402 Internationalization API this method is based upon the algorithm for Array.prototype.toLocaleString that is in the ECMA-402 specification.

23.2.3.32 %TypedArray%.prototype.toReversed ( )

This method performs the following steps when called:

  1. Let O be the this value.
  2. Let taRecord be ? ValidateTypedArray(O, seq-cst).
  3. Let length be TypedArrayLength(taRecord).
  4. Let A be ? TypedArrayCreateSameType(O, « 𝔽(length) »).
  5. Let k be 0.
  6. Repeat, while k < length,
    1. Let from be ! ToString(𝔽(length - k - 1)).
    2. Let Pk be ! ToString(𝔽(k)).
    3. Let fromValue be ! Get(O, from).
    4. Perform ! Set(A, Pk, fromValue, true).
    5. Set k to k + 1.
  7. Return A.

23.2.3.33 %TypedArray%.prototype.toSorted ( comparator )

This method performs the following steps when called:

  1. If comparator is not undefined and IsCallable(comparator) is false, throw a TypeError exception.
  2. Let O be the this value.
  3. Let taRecord be ? ValidateTypedArray(O, seq-cst).
  4. Let len be TypedArrayLength(taRecord).
  5. Let A be ? TypedArrayCreateSameType(O, « 𝔽(len) »).
  6. NOTE: The following closure performs a numeric comparison rather than the string comparison used in 23.1.3.34.
  7. Let SortCompare be a new Abstract Closure with parameters (x, y) that captures comparator and performs the following steps when called:
    1. Return ? CompareTypedArrayElements(x, y, comparator).
  8. Let sortedList be ? SortIndexedProperties(O, len, SortCompare, read-through-holes).
  9. Let j be 0.
  10. Repeat, while j < len,
    1. Perform ! Set(A, ! ToString(𝔽(j)), sortedList[j], true).
    2. Set j to j + 1.
  11. Return A.

23.2.3.34 %TypedArray%.prototype.toString ( )

The initial value of the "toString" property is %Array.prototype.toString%, defined in 23.1.3.36.

23.2.3.35 %TypedArray%.prototype.values ( )

This method performs the following steps when called:

  1. Let O be the this value.
  2. Perform ? ValidateTypedArray(O, seq-cst).
  3. Return CreateArrayIterator(O, value).

23.2.3.36 %TypedArray%.prototype.with ( index, value )

This method performs the following steps when called:

  1. Let O be the this value.
  2. Let taRecord be ? ValidateTypedArray(O, seq-cst).
  3. Let len be TypedArrayLength(taRecord).
  4. Let relativeIndex be ? ToIntegerOrInfinity(index).
  5. If relativeIndex ≥ 0, let actualIndex be relativeIndex.
  6. Else, let actualIndex be len + relativeIndex.
  7. If O.[[ContentType]] is bigint, let numericValue be ? ToBigInt(value).
  8. Else, let numericValue be ? ToNumber(value).
  9. If IsValidIntegerIndex(O, 𝔽(actualIndex)) is false, throw a RangeError exception.
  10. Let A be ? TypedArrayCreateSameType(O, « 𝔽(len) »).
  11. Let k be 0.
  12. Repeat, while k < len,
    1. Let Pk be ! ToString(𝔽(k)).
    2. If k = actualIndex, let fromValue be numericValue.
    3. Else, let fromValue be ! Get(O, Pk).
    4. Perform ! Set(A, Pk, fromValue, true).
    5. Set k to k + 1.
  13. Return A.

23.2.3.37 %TypedArray%.prototype [ %Symbol.iterator% ] ( )

The initial value of the %Symbol.iterator% property is %TypedArray.prototype.values%, defined in 23.2.3.35.

23.2.3.38 get %TypedArray%.prototype [ %Symbol.toStringTag% ]

%TypedArray%.prototype[%Symbol.toStringTag%] is an accessor property whose set accessor function is undefined. Its get accessor function performs the following steps when called:

  1. Let O be the this value.
  2. If O is not an Object, return undefined.
  3. If O does not have a [[TypedArrayName]] internal slot, return undefined.
  4. Let name be O.[[TypedArrayName]].
  5. Assert: name is a String.
  6. Return name.

This property has the attributes { [[Enumerable]]: false, [[Configurable]]: true }.

The initial value of the "name" property of this function is "get [Symbol.toStringTag]".

23.2.4 Abstract Operations for TypedArray Objects

23.2.4.1 TypedArrayCreateFromConstructor ( constructor, argumentList )

The abstract operation TypedArrayCreateFromConstructor takes arguments constructor (a constructor) and argumentList (a List of ECMAScript language values) and returns either a normal completion containing a TypedArray or a throw completion. It is used to specify the creation of a new TypedArray using a constructor function. It performs the following steps when called:

  1. Let newTypedArray be ? Construct(constructor, argumentList).
  2. Let taRecord be ? ValidateTypedArray(newTypedArray, seq-cst).
  3. Assert: newTypedArray has all the internal slots mentioned in Properties of TypedArray Instances.
  4. If the number of elements in argumentList is 1 and argumentList[0] is a Number, then
    1. If IsTypedArrayOutOfBounds(taRecord) is true, throw a TypeError exception.
    2. Let length be TypedArrayLength(taRecord).
    3. If length < (argumentList[0]), throw a TypeError exception.
  5. Return newTypedArray.

23.2.4.2 TypedArrayCreateSameType ( exemplar, argumentList )

The abstract operation TypedArrayCreateSameType takes arguments exemplar (a TypedArray) and argumentList (a List of ECMAScript language values) and returns either a normal completion containing a TypedArray or a throw completion. It is used to specify the creation of a new TypedArray using a constructor function that is derived from exemplar. Unlike TypedArraySpeciesCreate, which can construct custom TypedArray subclasses through the use of %Symbol.species%, this operation always uses one of the built-in TypedArray constructors. It performs the following steps when called:

  1. Let constructor be the intrinsic object associated with the constructor name exemplar.[[TypedArrayName]] in Table 75.
  2. Let result be ? TypedArrayCreateFromConstructor(constructor, argumentList).
  3. Assert: result.[[ContentType]] is exemplar.[[ContentType]].
  4. Return result.

23.2.4.3 TypedArraySpeciesCreate ( exemplar, argumentList )

The abstract operation TypedArraySpeciesCreate takes arguments exemplar (a TypedArray) and argumentList (a List of ECMAScript language values) and returns either a normal completion containing a TypedArray or a throw completion. It is used to specify the creation of a new TypedArray using a constructor function that is derived from exemplar. Unlike ArraySpeciesCreate, which can create non-Array objects through the use of %Symbol.species%, this operation enforces that the constructor function creates an actual TypedArray. It performs the following steps when called:

  1. Let defaultConstructor be the intrinsic object associated with the constructor name exemplar.[[TypedArrayName]] in Table 75.
  2. Let constructor be ? SpeciesConstructor(exemplar, defaultConstructor).
  3. Let result be ? TypedArrayCreateFromConstructor(constructor, argumentList).
  4. If result.[[ContentType]] is not exemplar.[[ContentType]], throw a TypeError exception.
  5. Return result.

23.2.4.4 ValidateTypedArray ( O, order )

The abstract operation ValidateTypedArray takes arguments O (an ECMAScript language value) and order (seq-cst or unordered) and returns either a normal completion containing a TypedArray With Buffer Witness Record or a throw completion. It performs the following steps when called:

  1. Perform ? RequireInternalSlot(O, [[TypedArrayName]]).
  2. Assert: O has a [[ViewedArrayBuffer]] internal slot.
  3. Let taRecord be MakeTypedArrayWithBufferWitnessRecord(O, order).
  4. If IsTypedArrayOutOfBounds(taRecord) is true, throw a TypeError exception.
  5. Return taRecord.

23.2.4.5 TypedArrayElementSize ( O )

The abstract operation TypedArrayElementSize takes argument O (a TypedArray) and returns a non-negative integer. It performs the following steps when called:

  1. Return the Element Size value specified in Table 75 for O.[[TypedArrayName]].

23.2.4.6 TypedArrayElementType ( O )

The abstract operation TypedArrayElementType takes argument O (a TypedArray) and returns a TypedArray element type. It performs the following steps when called:

  1. Return the Element Type value specified in Table 75 for O.[[TypedArrayName]].

23.2.4.7 CompareTypedArrayElements ( x, y, comparator )

The abstract operation CompareTypedArrayElements takes arguments x (a Number or a BigInt), y (a Number or a BigInt), and comparator (a function object or undefined) and returns either a normal completion containing a Number or an abrupt completion. It performs the following steps when called:

  1. Assert: x is a Number and y is a Number, or x is a BigInt and y is a BigInt.
  2. If comparator is not undefined, then
    1. Let v be ? ToNumber(? Call(comparator, undefined, « x, y »)).
    2. If v is NaN, return +0𝔽.
    3. Return v.
  3. If x and y are both NaN, return +0𝔽.
  4. If x is NaN, return 1𝔽.
  5. If y is NaN, return -1𝔽.
  6. If x < y, return -1𝔽.
  7. If x > y, return 1𝔽.
  8. If x is -0𝔽 and y is +0𝔽, return -1𝔽.
  9. If x is +0𝔽 and y is -0𝔽, return 1𝔽.
  10. Return +0𝔽.
Note
This performs a numeric comparison rather than the string comparison used in 23.1.3.30.2.

23.2.5 The TypedArray Constructors

Each TypedArray constructor:

  • is an intrinsic object that has the structure described below, differing only in the name used as the constructor name instead of TypedArray, in Table 75.
  • is a function whose behaviour differs based upon the number and types of its arguments. The actual behaviour of a call of TypedArray depends upon the number and kind of arguments that are passed to it.
  • is not intended to be called as a function and will throw an exception when called in that manner.
  • may be used as the value of an extends clause of a class definition. Subclass constructors that intend to inherit the specified TypedArray behaviour must include a super call to the TypedArray constructor to create and initialize the subclass instance with the internal state necessary to support the %TypedArray%.prototype built-in methods.

23.2.5.1 TypedArray ( ...args )

Each TypedArray constructor performs the following steps when called:

  1. If NewTarget is undefined, throw a TypeError exception.
  2. Let constructorName be the String value of the Constructor Name value specified in Table 75 for this TypedArray constructor.
  3. Let proto be "%TypedArray.prototype%".
  4. Let numberOfArgs be the number of elements in args.
  5. If numberOfArgs = 0, then
    1. Return ? AllocateTypedArray(constructorName, NewTarget, proto, 0).
  6. Else,
    1. Let firstArgument be args[0].
    2. If firstArgument is an Object, then
      1. Let O be ? AllocateTypedArray(constructorName, NewTarget, proto).
      2. If firstArgument has a [[TypedArrayName]] internal slot, then
        1. Perform ? InitializeTypedArrayFromTypedArray(O, firstArgument).
      3. Else if firstArgument has an [[ArrayBufferData]] internal slot, then
        1. If numberOfArgs > 1, let byteOffset be args[1]; else let byteOffset be undefined.
        2. If numberOfArgs > 2, let length be args[2]; else let length be undefined.
        3. Perform ? InitializeTypedArrayFromArrayBuffer(O, firstArgument, byteOffset, length).
      4. Else,
        1. Assert: firstArgument is an Object and firstArgument does not have either a [[TypedArrayName]] or an [[ArrayBufferData]] internal slot.
        2. Let usingIterator be ? GetMethod(firstArgument, %Symbol.iterator%).
        3. If usingIterator is not undefined, then
          1. Let values be ? IteratorToList(? GetIteratorFromMethod(firstArgument, usingIterator)).
          2. Perform ? InitializeTypedArrayFromList(O, values).
        4. Else,
          1. NOTE: firstArgument is not an iterable object, so assume it is already an array-like object.
          2. Perform ? InitializeTypedArrayFromArrayLike(O, firstArgument).
      5. Return O.
    3. Else,
      1. Assert: firstArgument is not an Object.
      2. Let elementLength be ? ToIndex(firstArgument).
      3. Return ? AllocateTypedArray(constructorName, NewTarget, proto, elementLength).

23.2.5.1.1 AllocateTypedArray ( constructorName, newTarget, defaultProto [ , length ] )

The abstract operation AllocateTypedArray takes arguments constructorName (a String which is the name of a TypedArray constructor in Table 75), newTarget (a constructor), and defaultProto (a String) and optional argument length (a non-negative integer) and returns either a normal completion containing a TypedArray or a throw completion. It is used to validate and create an instance of a TypedArray constructor. If the length argument is passed, an ArrayBuffer of that length is also allocated and associated with the new TypedArray instance. AllocateTypedArray provides common semantics that is used by TypedArray. It performs the following steps when called:

  1. Let proto be ? GetPrototypeFromConstructor(newTarget, defaultProto).
  2. Let obj be TypedArrayCreate(proto).
  3. Assert: obj.[[ViewedArrayBuffer]] is undefined.
  4. Set obj.[[TypedArrayName]] to constructorName.
  5. If constructorName is either "BigInt64Array" or "BigUint64Array", set obj.[[ContentType]] to bigint.
  6. Otherwise, set obj.[[ContentType]] to number.
  7. If length is not present, then
    1. Set obj.[[ByteLength]] to 0.
    2. Set obj.[[ByteOffset]] to 0.
    3. Set obj.[[ArrayLength]] to 0.
  8. Else,
    1. Perform ? AllocateTypedArrayBuffer(obj, length).
  9. Return obj.

23.2.5.1.2 InitializeTypedArrayFromTypedArray ( O, srcArray )

The abstract operation InitializeTypedArrayFromTypedArray takes arguments O (a TypedArray) and srcArray (a TypedArray) and returns either a normal completion containing unused or a throw completion. It performs the following steps when called:

  1. Let srcData be srcArray.[[ViewedArrayBuffer]].
  2. Let elementType be TypedArrayElementType(O).
  3. Let elementSize be TypedArrayElementSize(O).
  4. Let srcType be TypedArrayElementType(srcArray).
  5. Let srcElementSize be TypedArrayElementSize(srcArray).
  6. Let srcByteOffset be srcArray.[[ByteOffset]].
  7. Let srcRecord be MakeTypedArrayWithBufferWitnessRecord(srcArray, seq-cst).
  8. If IsTypedArrayOutOfBounds(srcRecord) is true, throw a TypeError exception.
  9. Let elementLength be TypedArrayLength(srcRecord).
  10. Let byteLength be elementSize × elementLength.
  11. If elementType is srcType, then
    1. Let data be ? CloneArrayBuffer(srcData, srcByteOffset, byteLength).
  12. Else,
    1. Let data be ? AllocateArrayBuffer(%ArrayBuffer%, byteLength).
    2. If srcArray.[[ContentType]] is not O.[[ContentType]], throw a TypeError exception.
    3. Let srcByteIndex be srcByteOffset.
    4. Let targetByteIndex be 0.
    5. Let count be elementLength.
    6. Repeat, while count > 0,
      1. Let value be GetValueFromBuffer(srcData, srcByteIndex, srcType, true, unordered).
      2. Perform SetValueInBuffer(data, targetByteIndex, elementType, value, true, unordered).
      3. Set srcByteIndex to srcByteIndex + srcElementSize.
      4. Set targetByteIndex to targetByteIndex + elementSize.
      5. Set count to count - 1.
  13. Set O.[[ViewedArrayBuffer]] to data.
  14. Set O.[[ByteLength]] to byteLength.
  15. Set O.[[ByteOffset]] to 0.
  16. Set O.[[ArrayLength]] to elementLength.
  17. Return unused.

23.2.5.1.3 InitializeTypedArrayFromArrayBuffer ( O, buffer, byteOffset, length )

The abstract operation InitializeTypedArrayFromArrayBuffer takes arguments O (a TypedArray), buffer (an ArrayBuffer or a SharedArrayBuffer), byteOffset (an ECMAScript language value), and length (an ECMAScript language value) and returns either a normal completion containing unused or a throw completion. It performs the following steps when called:

  1. Let elementSize be TypedArrayElementSize(O).
  2. Let offset be ? ToIndex(byteOffset).
  3. If offset modulo elementSize ≠ 0, throw a RangeError exception.
  4. Let bufferIsFixedLength be IsFixedLengthArrayBuffer(buffer).
  5. If length is not undefined, then
    1. Let newLength be ? ToIndex(length).
  6. If IsDetachedBuffer(buffer) is true, throw a TypeError exception.
  7. Let bufferByteLength be ArrayBufferByteLength(buffer, seq-cst).
  8. If length is undefined and bufferIsFixedLength is false, then
    1. If offset > bufferByteLength, throw a RangeError exception.
    2. Set O.[[ByteLength]] to auto.
    3. Set O.[[ArrayLength]] to auto.
  9. Else,
    1. If length is undefined, then
      1. If bufferByteLength modulo elementSize ≠ 0, throw a RangeError exception.
      2. Let newByteLength be bufferByteLength - offset.
      3. If newByteLength < 0, throw a RangeError exception.
    2. Else,
      1. Let newByteLength be newLength × elementSize.
      2. If offset + newByteLength > bufferByteLength, throw a RangeError exception.
    3. Set O.[[ByteLength]] to newByteLength.
    4. Set O.[[ArrayLength]] to newByteLength / elementSize.
  10. Set O.[[ViewedArrayBuffer]] to buffer.
  11. Set O.[[ByteOffset]] to offset.
  12. Return unused.

23.2.5.1.4 InitializeTypedArrayFromList ( O, values )

The abstract operation InitializeTypedArrayFromList takes arguments O (a TypedArray) and values (a List of ECMAScript language values) and returns either a normal completion containing unused or a throw completion. It performs the following steps when called:

  1. Let len be the number of elements in values.
  2. Perform ? AllocateTypedArrayBuffer(O, len).
  3. Let k be 0.
  4. Repeat, while k < len,
    1. Let Pk be ! ToString(𝔽(k)).
    2. Let kValue be the first element of values.
    3. Remove the first element from values.
    4. Perform ? Set(O, Pk, kValue, true).
    5. Set k to k + 1.
  5. Assert: values is now an empty List.
  6. Return unused.

23.2.5.1.5 InitializeTypedArrayFromArrayLike ( O, arrayLike )

The abstract operation InitializeTypedArrayFromArrayLike takes arguments O (a TypedArray) and arrayLike (an Object, but not a TypedArray or an ArrayBuffer) and returns either a normal completion containing unused or a throw completion. It performs the following steps when called:

  1. Let len be ? LengthOfArrayLike(arrayLike).
  2. Perform ? AllocateTypedArrayBuffer(O, len).
  3. Let k be 0.
  4. Repeat, while k < len,
    1. Let Pk be ! ToString(𝔽(k)).
    2. Let kValue be ? Get(arrayLike, Pk).
    3. Perform ? Set(O, Pk, kValue, true).
    4. Set k to k + 1.
  5. Return unused.

23.2.5.1.6 AllocateTypedArrayBuffer ( O, length )

The abstract operation AllocateTypedArrayBuffer takes arguments O (a TypedArray) and length (a non-negative integer) and returns either a normal completion containing unused or a throw completion. It allocates and associates an ArrayBuffer with O. It performs the following steps when called:

  1. Assert: O.[[ViewedArrayBuffer]] is undefined.
  2. Let elementSize be TypedArrayElementSize(O).
  3. Let byteLength be elementSize × length.
  4. Let data be ? AllocateArrayBuffer(%ArrayBuffer%, byteLength).
  5. Set O.[[ViewedArrayBuffer]] to data.
  6. Set O.[[ByteLength]] to byteLength.
  7. Set O.[[ByteOffset]] to 0.
  8. Set O.[[ArrayLength]] to length.
  9. Return unused.

23.2.6 Properties of the TypedArray Constructors

Each TypedArray constructor:

  • has a [[Prototype]] internal slot whose value is %TypedArray%.
  • has a "length" property whose value is 3𝔽.
  • has a "name" property whose value is the String value of the constructor name specified for it in Table 75.
  • has the following properties:

23.2.6.1 TypedArray.BYTES_PER_ELEMENT

The value of TypedArray.BYTES_PER_ELEMENT is the Element Size value specified in Table 75 for TypedArray.

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: false }.

23.2.6.2 TypedArray.prototype

The initial value of TypedArray.prototype is the corresponding TypedArray prototype intrinsic object (23.2.7).

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: false }.

23.2.7 Properties of the TypedArray Prototype Objects

Each TypedArray prototype object:

  • has a [[Prototype]] internal slot whose value is %TypedArray.prototype%.
  • is an ordinary object.
  • does not have a [[ViewedArrayBuffer]] or any other of the internal slots that are specific to TypedArray instance objects.

23.2.7.1 TypedArray.prototype.BYTES_PER_ELEMENT

The value of TypedArray.prototype.BYTES_PER_ELEMENT is the Element Size value specified in Table 75 for TypedArray.

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: false }.

23.2.7.2 TypedArray.prototype.constructor

The initial value of the "constructor" property of the prototype for a given TypedArray constructor is the constructor itself.

23.2.8 Properties of TypedArray Instances

TypedArray instances are TypedArrays. Each TypedArray instance inherits properties from the corresponding TypedArray prototype object. Each TypedArray instance has the following internal slots: [[ViewedArrayBuffer]], [[TypedArrayName]], [[ContentType]], [[ByteLength]], [[ByteOffset]], and [[ArrayLength]].

24 Keyed Collections

24.1 Map Objects

Maps are collections of key/value pairs where both the keys and values may be arbitrary ECMAScript language values. A distinct key value may only occur in one key/value pair within the Map's collection. Distinct key values are discriminated using the semantics of the SameValueZero comparison algorithm.

Maps must be implemented using either hash tables or other mechanisms that, on average, provide access times that are sublinear on the number of elements in the collection. The data structure used in this specification is only intended to describe the required observable semantics of Maps. It is not intended to be a viable implementation model.

24.1.1 The Map Constructor

The Map constructor:

  • is %Map%.
  • is the initial value of the "Map" property of the global object.
  • creates and initializes a new Map when called as a constructor.
  • is not intended to be called as a function and will throw an exception when called in that manner.
  • may be used as the value in an extends clause of a class definition. Subclass constructors that intend to inherit the specified Map behaviour must include a super call to the Map constructor to create and initialize the subclass instance with the internal state necessary to support the Map.prototype built-in methods.

24.1.1.1 Map ( [ iterable ] )

This function performs the following steps when called:

  1. If NewTarget is undefined, throw a TypeError exception.
  2. Let map be ? OrdinaryCreateFromConstructor(NewTarget, "%Map.prototype%", « [[MapData]] »).
  3. Set map.[[MapData]] to a new empty List.
  4. If iterable is either undefined or null, return map.
  5. Let adder be ? Get(map, "set").
  6. If IsCallable(adder) is false, throw a TypeError exception.
  7. Return ? AddEntriesFromIterable(map, iterable, adder).
Note

If the parameter iterable is present, it is expected to be an object that implements a %Symbol.iterator% method that returns an iterator object that produces a two element array-like object whose first element is a value that will be used as a Map key and whose second element is the value to associate with that key.

24.1.1.2 AddEntriesFromIterable ( target, iterable, adder )

The abstract operation AddEntriesFromIterable takes arguments target (an Object), iterable (an ECMAScript language value, but not undefined or null), and adder (a function object) and returns either a normal completion containing an ECMAScript language value or a throw completion. adder will be invoked, with target as the receiver. It performs the following steps when called:

  1. Let iteratorRecord be ? GetIterator(iterable, sync).
  2. Repeat,
    1. Let next be ? IteratorStepValue(iteratorRecord).
    2. If next is done, return target.
    3. If next is not an Object, then
      1. Let error be ThrowCompletion(a newly created TypeError object).
      2. Return ? IteratorClose(iteratorRecord, error).
    4. Let k be Completion(Get(next, "0")).
    5. IfAbruptCloseIterator(k, iteratorRecord).
    6. Let v be Completion(Get(next, "1")).
    7. IfAbruptCloseIterator(v, iteratorRecord).
    8. Let status be Completion(Call(adder, target, « k, v »)).
    9. IfAbruptCloseIterator(status, iteratorRecord).
Note

The parameter iterable is expected to be an object that implements a %Symbol.iterator% method that returns an iterator object that produces a two element array-like object whose first element is a value that will be used as a Map key and whose second element is the value to associate with that key.

24.1.2 Properties of the Map Constructor

The Map constructor:

  • has a [[Prototype]] internal slot whose value is %Function.prototype%.
  • has the following properties:

24.1.2.1 Map.groupBy ( items, callback )

Note

callback should be a function that accepts two arguments. groupBy calls callback once for each element in items, in ascending order, and constructs a new Map. Each value returned by callback is used as a key in the Map. For each such key, the result Map has an entry whose key is that key and whose value is an array containing all the elements for which callback returned that key.

callback is called with two arguments: the value of the element and the index of the element.

The return value of groupBy is a Map.

This function performs the following steps when called:

  1. Let groups be ? GroupBy(items, callback, collection).
  2. Let map be ! Construct(%Map%).
  3. For each Record { [[Key]], [[Elements]] } g of groups, do
    1. Let elements be CreateArrayFromList(g.[[Elements]]).
    2. Let entry be the Record { [[Key]]: g.[[Key]], [[Value]]: elements }.
    3. Append entry to map.[[MapData]].
  4. Return map.

24.1.2.2 Map.prototype

The initial value of Map.prototype is the Map prototype object.

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: false }.

24.1.2.3 get Map [ %Symbol.species% ]

Map[%Symbol.species%] is an accessor property whose set accessor function is undefined. Its get accessor function performs the following steps when called:

  1. Return the this value.

The value of the "name" property of this function is "get [Symbol.species]".

Note

Methods that create derived collection objects should call %Symbol.species% to determine the constructor to use to create the derived objects. Subclass constructor may over-ride %Symbol.species% to change the default constructor assignment.

24.1.3 Properties of the Map Prototype Object

The Map prototype object:

24.1.3.1 Map.prototype.clear ( )

This method performs the following steps when called:

  1. Let M be the this value.
  2. Perform ? RequireInternalSlot(M, [[MapData]]).
  3. For each Record { [[Key]], [[Value]] } p of M.[[MapData]], do
    1. Set p.[[Key]] to empty.
    2. Set p.[[Value]] to empty.
  4. Return undefined.
Note

The existing [[MapData]] List is preserved because there may be existing Map Iterator objects that are suspended midway through iterating over that List.

24.1.3.2 Map.prototype.constructor

The initial value of Map.prototype.constructor is %Map%.

24.1.3.3 Map.prototype.delete ( key )

This method performs the following steps when called:

  1. Let M be the this value.
  2. Perform ? RequireInternalSlot(M, [[MapData]]).
  3. Set key to CanonicalizeKeyedCollectionKey(key).
  4. For each Record { [[Key]], [[Value]] } p of M.[[MapData]], do
    1. If p.[[Key]] is not empty and SameValue(p.[[Key]], key) is true, then
      1. Set p.[[Key]] to empty.
      2. Set p.[[Value]] to empty.
      3. Return true.
  5. Return false.
Note

The value empty is used as a specification device to indicate that an entry has been deleted. Actual implementations may take other actions such as physically removing the entry from internal data structures.

24.1.3.4 Map.prototype.entries ( )

This method performs the following steps when called:

  1. Let M be the this value.
  2. Return ? CreateMapIterator(M, key+value).

24.1.3.5 Map.prototype.forEach ( callback [ , thisArg ] )

This method performs the following steps when called:

  1. Let M be the this value.
  2. Perform ? RequireInternalSlot(M, [[MapData]]).
  3. If IsCallable(callback) is false, throw a TypeError exception.
  4. Let entries be M.[[MapData]].
  5. Let numEntries be the number of elements in entries.
  6. Let index be 0.
  7. Repeat, while index < numEntries,
    1. Let e be entries[index].
    2. Set index to index + 1.
    3. If e.[[Key]] is not empty, then
      1. Perform ? Call(callback, thisArg, « e.[[Value]], e.[[Key]], M »).
      2. NOTE: The number of elements in entries may have increased during execution of callback.
      3. Set numEntries to the number of elements in entries.
  8. Return undefined.
Note

callback should be a function that accepts three arguments. forEach calls callback once for each key/value pair present in the Map, in key insertion order. callback is called only for keys of the Map which actually exist; it is not called for keys that have been deleted from the Map.

If a thisArg parameter is provided, it will be used as the this value for each invocation of callback. If it is not provided, undefined is used instead.

callback is called with three arguments: the value of the item, the key of the item, and the Map being traversed.

forEach does not directly mutate the object on which it is called but the object may be mutated by the calls to callback. Each entry of a map's [[MapData]] is only visited once. New keys added after the call to forEach begins are visited. A key will be revisited if it is deleted after it has been visited and then re-added before the forEach call completes. Keys that are deleted after the call to forEach begins and before being visited are not visited unless the key is added again before the forEach call completes.

24.1.3.6 Map.prototype.get ( key )

This method performs the following steps when called:

  1. Let M be the this value.
  2. Perform ? RequireInternalSlot(M, [[MapData]]).
  3. Set key to CanonicalizeKeyedCollectionKey(key).
  4. For each Record { [[Key]], [[Value]] } p of M.[[MapData]], do
    1. If p.[[Key]] is not empty and SameValue(p.[[Key]], key) is true, return p.[[Value]].
  5. Return undefined.

24.1.3.7 Map.prototype.has ( key )

This method performs the following steps when called:

  1. Let M be the this value.
  2. Perform ? RequireInternalSlot(M, [[MapData]]).
  3. Set key to CanonicalizeKeyedCollectionKey(key).
  4. For each Record { [[Key]], [[Value]] } p of M.[[MapData]], do
    1. If p.[[Key]] is not empty and SameValue(p.[[Key]], key) is true, return true.
  5. Return false.

24.1.3.8 Map.prototype.keys ( )

This method performs the following steps when called:

  1. Let M be the this value.
  2. Return ? CreateMapIterator(M, key).

24.1.3.9 Map.prototype.set ( key, value )

This method performs the following steps when called:

  1. Let M be the this value.
  2. Perform ? RequireInternalSlot(M, [[MapData]]).
  3. Set key to CanonicalizeKeyedCollectionKey(key).
  4. For each Record { [[Key]], [[Value]] } p of M.[[MapData]], do
    1. If p.[[Key]] is not empty and SameValue(p.[[Key]], key) is true, then
      1. Set p.[[Value]] to value.
      2. Return M.
  5. Let p be the Record { [[Key]]: key, [[Value]]: value }.
  6. Append p to M.[[MapData]].
  7. Return M.

24.1.3.10 get Map.prototype.size

Map.prototype.size is an accessor property whose set accessor function is undefined. Its get accessor function performs the following steps when called:

  1. Let M be the this value.
  2. Perform ? RequireInternalSlot(M, [[MapData]]).
  3. Let count be 0.
  4. For each Record { [[Key]], [[Value]] } p of M.[[MapData]], do
    1. If p.[[Key]] is not empty, set count to count + 1.
  5. Return 𝔽(count).

24.1.3.11 Map.prototype.values ( )

This method performs the following steps when called:

  1. Let M be the this value.
  2. Return ? CreateMapIterator(M, value).

24.1.3.12 Map.prototype [ %Symbol.iterator% ] ( )

The initial value of the %Symbol.iterator% property is %Map.prototype.entries%, defined in 24.1.3.4.

24.1.3.13 Map.prototype [ %Symbol.toStringTag% ]

The initial value of the %Symbol.toStringTag% property is the String value "Map".

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: true }.

24.1.4 Properties of Map Instances

Map instances are ordinary objects that inherit properties from the Map prototype object. Map instances also have a [[MapData]] internal slot.

24.1.5 Map Iterator Objects

A Map Iterator is an object that represents a specific iteration over some specific Map instance object. There is not a named constructor for Map Iterator objects. Instead, Map Iterator objects are created by calling certain methods of Map instance objects.

24.1.5.1 CreateMapIterator ( map, kind )

The abstract operation CreateMapIterator takes arguments map (an ECMAScript language value) and kind (key+value, key, or value) and returns either a normal completion containing a Generator or a throw completion. It is used to create iterator objects for Map methods that return such iterators. It performs the following steps when called:

  1. Perform ? RequireInternalSlot(map, [[MapData]]).
  2. Let closure be a new Abstract Closure with no parameters that captures map and kind and performs the following steps when called:
    1. Let entries be map.[[MapData]].
    2. Let index be 0.
    3. Let numEntries be the number of elements in entries.
    4. Repeat, while index < numEntries,
      1. Let e be entries[index].
      2. Set index to index + 1.
      3. If e.[[Key]] is not empty, then
        1. If kind is key, then
          1. Let result be e.[[Key]].
        2. Else if kind is value, then
          1. Let result be e.[[Value]].
        3. Else,
          1. Assert: kind is key+value.
          2. Let result be CreateArrayFromListe.[[Key]], e.[[Value]] »).
        4. Perform ? GeneratorYield(CreateIteratorResultObject(result, false)).
        5. NOTE: The number of elements in entries may have increased while execution of this abstract operation was paused by GeneratorYield.
        6. Set numEntries to the number of elements in entries.
    5. Return NormalCompletion(unused).
  3. Return CreateIteratorFromClosure(closure, "%MapIteratorPrototype%", %MapIteratorPrototype%).

24.1.5.2 The %MapIteratorPrototype% Object

The %MapIteratorPrototype% object:

24.1.5.2.1 %MapIteratorPrototype%.next ( )

  1. Return ? GeneratorResume(this value, empty, "%MapIteratorPrototype%").

24.1.5.2.2 %MapIteratorPrototype% [ %Symbol.toStringTag% ]

The initial value of the %Symbol.toStringTag% property is the String value "Map Iterator".

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: true }.

24.2 Set Objects

Set objects are collections of ECMAScript language values. A distinct value may only occur once as an element of a Set's collection. Distinct values are discriminated using the semantics of the SameValueZero comparison algorithm.

Set objects must be implemented using either hash tables or other mechanisms that, on average, provide access times that are sublinear on the number of elements in the collection. The data structure used in this specification is only intended to describe the required observable semantics of Set objects. It is not intended to be a viable implementation model.

24.2.1 Abstract Operations For Set Objects

24.2.1.1 Set Records

A Set Record is a Record value used to encapsulate the interface of a Set or similar object.

Set Records have the fields listed in Table 76.

Table 76: Set Record Fields
Field Name Value Meaning
[[SetObject]] an Object the Set or similar object.
[[Size]] a non-negative integer or +∞ The reported size of the object.
[[Has]] a function object The has method of the object.
[[Keys]] a function object The keys method of the object.

24.2.1.2 GetSetRecord ( obj )

The abstract operation GetSetRecord takes argument obj (an ECMAScript language value) and returns either a normal completion containing a Set Record or a throw completion. It performs the following steps when called:

  1. If obj is not an Object, throw a TypeError exception.
  2. Let rawSize be ? Get(obj, "size").
  3. Let numSize be ? ToNumber(rawSize).
  4. NOTE: If rawSize is undefined, then numSize will be NaN.
  5. If numSize is NaN, throw a TypeError exception.
  6. Let intSize be ! ToIntegerOrInfinity(numSize).
  7. If intSize < 0, throw a RangeError exception.
  8. Let has be ? Get(obj, "has").
  9. If IsCallable(has) is false, throw a TypeError exception.
  10. Let keys be ? Get(obj, "keys").
  11. If IsCallable(keys) is false, throw a TypeError exception.
  12. Return a new Set Record { [[SetObject]]: obj, [[Size]]: intSize, [[Has]]: has, [[Keys]]: keys }.

24.2.1.3 SetDataHas ( setData, value )

The abstract operation SetDataHas takes arguments setData (a List of either ECMAScript language values or empty) and value (an ECMAScript language value) and returns a Boolean. It performs the following steps when called:

  1. If SetDataIndex(setData, value) is not-found, return false.
  2. Return true.

24.2.1.4 SetDataIndex ( setData, value )

The abstract operation SetDataIndex takes arguments setData (a List of either ECMAScript language values or empty) and value (an ECMAScript language value) and returns a non-negative integer or not-found. It performs the following steps when called:

  1. Set value to CanonicalizeKeyedCollectionKey(value).
  2. Let size be the number of elements in setData.
  3. Let index be 0.
  4. Repeat, while index < size,
    1. Let e be setData[index].
    2. If e is not empty and e is value, then
      1. Return index.
    3. Set index to index + 1.
  5. Return not-found.

24.2.1.5 SetDataSize ( setData )

The abstract operation SetDataSize takes argument setData (a List of either ECMAScript language values or empty) and returns a non-negative integer. It performs the following steps when called:

  1. Let count be 0.
  2. For each element e of setData, do
    1. If e is not empty, set count to count + 1.
  3. Return count.

24.2.2 The Set Constructor

The Set constructor:

  • is %Set%.
  • is the initial value of the "Set" property of the global object.
  • creates and initializes a new Set object when called as a constructor.
  • is not intended to be called as a function and will throw an exception when called in that manner.
  • may be used as the value in an extends clause of a class definition. Subclass constructors that intend to inherit the specified Set behaviour must include a super call to the Set constructor to create and initialize the subclass instance with the internal state necessary to support the Set.prototype built-in methods.

24.2.2.1 Set ( [ iterable ] )

This function performs the following steps when called:

  1. If NewTarget is undefined, throw a TypeError exception.
  2. Let set be ? OrdinaryCreateFromConstructor(NewTarget, "%Set.prototype%", « [[SetData]] »).
  3. Set set.[[SetData]] to a new empty List.
  4. If iterable is either undefined or null, return set.
  5. Let adder be ? Get(set, "add").
  6. If IsCallable(adder) is false, throw a TypeError exception.
  7. Let iteratorRecord be ? GetIterator(iterable, sync).
  8. Repeat,
    1. Let next be ? IteratorStepValue(iteratorRecord).
    2. If next is done, return set.
    3. Let status be Completion(Call(adder, set, « next »)).
    4. IfAbruptCloseIterator(status, iteratorRecord).

24.2.3 Properties of the Set Constructor

The Set constructor:

  • has a [[Prototype]] internal slot whose value is %Function.prototype%.
  • has the following properties:

24.2.3.1 Set.prototype

The initial value of Set.prototype is the Set prototype object.

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: false }.

24.2.3.2 get Set [ %Symbol.species% ]

Set[%Symbol.species%] is an accessor property whose set accessor function is undefined. Its get accessor function performs the following steps when called:

  1. Return the this value.

The value of the "name" property of this function is "get [Symbol.species]".

Note

Methods that create derived collection objects should call %Symbol.species% to determine the constructor to use to create the derived objects. Subclass constructor may over-ride %Symbol.species% to change the default constructor assignment.

24.2.4 Properties of the Set Prototype Object

The Set prototype object:

24.2.4.1 Set.prototype.add ( value )

This method performs the following steps when called:

  1. Let S be the this value.
  2. Perform ? RequireInternalSlot(S, [[SetData]]).
  3. Set value to CanonicalizeKeyedCollectionKey(value).
  4. For each element e of S.[[SetData]], do
    1. If e is not empty and SameValue(e, value) is true, then
      1. Return S.
  5. Append value to S.[[SetData]].
  6. Return S.

24.2.4.2 Set.prototype.clear ( )

This method performs the following steps when called:

  1. Let S be the this value.
  2. Perform ? RequireInternalSlot(S, [[SetData]]).
  3. For each element e of S.[[SetData]], do
    1. Replace the element of S.[[SetData]] whose value is e with an element whose value is empty.
  4. Return undefined.
Note

The existing [[SetData]] List is preserved because there may be existing Set Iterator objects that are suspended midway through iterating over that List.

24.2.4.3 Set.prototype.constructor

The initial value of Set.prototype.constructor is %Set%.

24.2.4.4 Set.prototype.delete ( value )

This method performs the following steps when called:

  1. Let S be the this value.
  2. Perform ? RequireInternalSlot(S, [[SetData]]).
  3. Set value to CanonicalizeKeyedCollectionKey(value).
  4. For each element e of S.[[SetData]], do
    1. If e is not empty and SameValue(e, value) is true, then
      1. Replace the element of S.[[SetData]] whose value is e with an element whose value is empty.
      2. Return true.
  5. Return false.
Note

The value empty is used as a specification device to indicate that an entry has been deleted. Actual implementations may take other actions such as physically removing the entry from internal data structures.

24.2.4.5 Set.prototype.difference ( other )

This method performs the following steps when called:

  1. Let O be the this value.
  2. Perform ? RequireInternalSlot(O, [[SetData]]).
  3. Let otherRec be ? GetSetRecord(other).
  4. Let resultSetData be a copy of O.[[SetData]].
  5. If SetDataSize(O.[[SetData]]) ≤ otherRec.[[Size]], then
    1. Let thisSize be the number of elements in O.[[SetData]].
    2. Let index be 0.
    3. Repeat, while index < thisSize,
      1. Let e be resultSetData[index].
      2. If e is not empty, then
        1. Let inOther be ToBoolean(? Call(otherRec.[[Has]], otherRec.[[SetObject]], « e »)).
        2. If inOther is true, then
          1. Set resultSetData[index] to empty.
      3. Set index to index + 1.
  6. Else,
    1. Let keysIter be ? GetIteratorFromMethod(otherRec.[[SetObject]], otherRec.[[Keys]]).
    2. Let next be not-started.
    3. Repeat, while next is not done,
      1. Set next to ? IteratorStepValue(keysIter).
      2. If next is not done, then
        1. Set next to CanonicalizeKeyedCollectionKey(next).
        2. Let valueIndex be SetDataIndex(resultSetData, next).
        3. If valueIndex is not not-found, then
          1. Set resultSetData[valueIndex] to empty.
  7. Let result be OrdinaryObjectCreate(%Set.prototype%, « [[SetData]] »).
  8. Set result.[[SetData]] to resultSetData.
  9. Return result.

24.2.4.6 Set.prototype.entries ( )

This method performs the following steps when called:

  1. Let S be the this value.
  2. Return ? CreateSetIterator(S, key+value).
Note

For iteration purposes, a Set appears similar to a Map where each entry has the same value for its key and value.

24.2.4.7 Set.prototype.forEach ( callback [ , thisArg ] )

This method performs the following steps when called:

  1. Let S be the this value.
  2. Perform ? RequireInternalSlot(S, [[SetData]]).
  3. If IsCallable(callback) is false, throw a TypeError exception.
  4. Let entries be S.[[SetData]].
  5. Let numEntries be the number of elements in entries.
  6. Let index be 0.
  7. Repeat, while index < numEntries,
    1. Let e be entries[index].
    2. Set index to index + 1.
    3. If e is not empty, then
      1. Perform ? Call(callback, thisArg, « e, e, S »).
      2. NOTE: The number of elements in entries may have increased during execution of callback.
      3. Set numEntries to the number of elements in entries.
  8. Return undefined.
Note

callback should be a function that accepts three arguments. forEach calls callback once for each value present in the Set object, in value insertion order. callback is called only for values of the Set which actually exist; it is not called for keys that have been deleted from the set.

If a thisArg parameter is provided, it will be used as the this value for each invocation of callback. If it is not provided, undefined is used instead.

callback is called with three arguments: the first two arguments are a value contained in the Set. The same value is passed for both arguments. The Set object being traversed is passed as the third argument.

The callback is called with three arguments to be consistent with the call back functions used by forEach methods for Map and Array. For Sets, each item value is considered to be both the key and the value.

forEach does not directly mutate the object on which it is called but the object may be mutated by the calls to callback.

Each value is normally visited only once. However, a value will be revisited if it is deleted after it has been visited and then re-added before the forEach call completes. Values that are deleted after the call to forEach begins and before being visited are not visited unless the value is added again before the forEach call completes. New values added after the call to forEach begins are visited.

24.2.4.8 Set.prototype.has ( value )

This method performs the following steps when called:

  1. Let S be the this value.
  2. Perform ? RequireInternalSlot(S, [[SetData]]).
  3. Set value to CanonicalizeKeyedCollectionKey(value).
  4. For each element e of S.[[SetData]], do
    1. If e is not empty and SameValue(e, value) is true, return true.
  5. Return false.

24.2.4.9 Set.prototype.intersection ( other )

This method performs the following steps when called:

  1. Let O be the this value.
  2. Perform ? RequireInternalSlot(O, [[SetData]]).
  3. Let otherRec be ? GetSetRecord(other).
  4. Let resultSetData be a new empty List.
  5. If SetDataSize(O.[[SetData]]) ≤ otherRec.[[Size]], then
    1. Let thisSize be the number of elements in O.[[SetData]].
    2. Let index be 0.
    3. Repeat, while index < thisSize,
      1. Let e be O.[[SetData]][index].
      2. Set index to index + 1.
      3. If e is not empty, then
        1. Let inOther be ToBoolean(? Call(otherRec.[[Has]], otherRec.[[SetObject]], « e »)).
        2. If inOther is true, then
          1. NOTE: It is possible for earlier calls to otherRec.[[Has]] to remove and re-add an element of O.[[SetData]], which can cause the same element to be visited twice during this iteration.
          2. If SetDataHas(resultSetData, e) is false, then
            1. Append e to resultSetData.
        3. NOTE: The number of elements in O.[[SetData]] may have increased during execution of otherRec.[[Has]].
        4. Set thisSize to the number of elements in O.[[SetData]].
  6. Else,
    1. Let keysIter be ? GetIteratorFromMethod(otherRec.[[SetObject]], otherRec.[[Keys]]).
    2. Let next be not-started.
    3. Repeat, while next is not done,
      1. Set next to ? IteratorStepValue(keysIter).
      2. If next is not done, then
        1. Set next to CanonicalizeKeyedCollectionKey(next).
        2. Let inThis be SetDataHas(O.[[SetData]], next).
        3. If inThis is true, then
          1. NOTE: Because other is an arbitrary object, it is possible for its "keys" iterator to produce the same value more than once.
          2. If SetDataHas(resultSetData, next) is false, then
            1. Append next to resultSetData.
  7. Let result be OrdinaryObjectCreate(%Set.prototype%, « [[SetData]] »).
  8. Set result.[[SetData]] to resultSetData.
  9. Return result.

24.2.4.10 Set.prototype.isDisjointFrom ( other )

This method performs the following steps when called:

  1. Let O be the this value.
  2. Perform ? RequireInternalSlot(O, [[SetData]]).
  3. Let otherRec be ? GetSetRecord(other).
  4. If SetDataSize(O.[[SetData]]) ≤ otherRec.[[Size]], then
    1. Let thisSize be the number of elements in O.[[SetData]].
    2. Let index be 0.
    3. Repeat, while index < thisSize,
      1. Let e be O.[[SetData]][index].
      2. Set index to index + 1.
      3. If e is not empty, then
        1. Let inOther be ToBoolean(? Call(otherRec.[[Has]], otherRec.[[SetObject]], « e »)).
        2. If inOther is true, return false.
        3. NOTE: The number of elements in O.[[SetData]] may have increased during execution of otherRec.[[Has]].
        4. Set thisSize to the number of elements in O.[[SetData]].
  5. Else,
    1. Let keysIter be ? GetIteratorFromMethod(otherRec.[[SetObject]], otherRec.[[Keys]]).
    2. Let next be not-started.
    3. Repeat, while next is not done,
      1. Set next to ? IteratorStepValue(keysIter).
      2. If next is not done, then
        1. If SetDataHas(O.[[SetData]], next) is true, then
          1. Perform ? IteratorClose(keysIter, NormalCompletion(unused)).
          2. Return false.
  6. Return true.

24.2.4.11 Set.prototype.isSubsetOf ( other )

This method performs the following steps when called:

  1. Let O be the this value.
  2. Perform ? RequireInternalSlot(O, [[SetData]]).
  3. Let otherRec be ? GetSetRecord(other).
  4. If SetDataSize(O.[[SetData]]) > otherRec.[[Size]], return false.
  5. Let thisSize be the number of elements in O.[[SetData]].
  6. Let index be 0.
  7. Repeat, while index < thisSize,
    1. Let e be O.[[SetData]][index].
    2. Set index to index + 1.
    3. If e is not empty, then
      1. Let inOther be ToBoolean(? Call(otherRec.[[Has]], otherRec.[[SetObject]], « e »)).
      2. If inOther is false, return false.
      3. NOTE: The number of elements in O.[[SetData]] may have increased during execution of otherRec.[[Has]].
      4. Set thisSize to the number of elements in O.[[SetData]].
  8. Return true.

24.2.4.12 Set.prototype.isSupersetOf ( other )

This method performs the following steps when called:

  1. Let O be the this value.
  2. Perform ? RequireInternalSlot(O, [[SetData]]).
  3. Let otherRec be ? GetSetRecord(other).
  4. If SetDataSize(O.[[SetData]]) < otherRec.[[Size]], return false.
  5. Let keysIter be ? GetIteratorFromMethod(otherRec.[[SetObject]], otherRec.[[Keys]]).
  6. Let next be not-started.
  7. Repeat, while next is not done,
    1. Set next to ? IteratorStepValue(keysIter).
    2. If next is not done, then
      1. If SetDataHas(O.[[SetData]], next) is false, then
        1. Perform ? IteratorClose(keysIter, NormalCompletion(unused)).
        2. Return false.
  8. Return true.

24.2.4.13 Set.prototype.keys ( )

The initial value of the "keys" property is %Set.prototype.values%, defined in 24.2.4.17.

Note

For iteration purposes, a Set appears similar to a Map where each entry has the same value for its key and value.

24.2.4.14 get Set.prototype.size

Set.prototype.size is an accessor property whose set accessor function is undefined. Its get accessor function performs the following steps when called:

  1. Let S be the this value.
  2. Perform ? RequireInternalSlot(S, [[SetData]]).
  3. Let size be SetDataSize(S.[[SetData]]).
  4. Return 𝔽(size).

24.2.4.15 Set.prototype.symmetricDifference ( other )

This method performs the following steps when called:

  1. Let O be the this value.
  2. Perform ? RequireInternalSlot(O, [[SetData]]).
  3. Let otherRec be ? GetSetRecord(other).
  4. Let keysIter be ? GetIteratorFromMethod(otherRec.[[SetObject]], otherRec.[[Keys]]).
  5. Let resultSetData be a copy of O.[[SetData]].
  6. Let next be not-started.
  7. Repeat, while next is not done,
    1. Set next to ? IteratorStepValue(keysIter).
    2. If next is not done, then
      1. Set next to CanonicalizeKeyedCollectionKey(next).
      2. Let resultIndex be SetDataIndex(resultSetData, next).
      3. If resultIndex is not-found, let alreadyInResult be false; otherwise let alreadyInResult be true.
      4. If SetDataHas(O.[[SetData]], next) is true, then
        1. If alreadyInResult is true, set resultSetData[resultIndex] to empty.
      5. Else,
        1. If alreadyInResult is false, append next to resultSetData.
  8. Let result be OrdinaryObjectCreate(%Set.prototype%, « [[SetData]] »).
  9. Set result.[[SetData]] to resultSetData.
  10. Return result.

24.2.4.16 Set.prototype.union ( other )

This method performs the following steps when called:

  1. Let O be the this value.
  2. Perform ? RequireInternalSlot(O, [[SetData]]).
  3. Let otherRec be ? GetSetRecord(other).
  4. Let keysIter be ? GetIteratorFromMethod(otherRec.[[SetObject]], otherRec.[[Keys]]).
  5. Let resultSetData be a copy of O.[[SetData]].
  6. Let next be not-started.
  7. Repeat, while next is not done,
    1. Set next to ? IteratorStepValue(keysIter).
    2. If next is not done, then
      1. Set next to CanonicalizeKeyedCollectionKey(next).
      2. If SetDataHas(resultSetData, next) is false, then
        1. Append next to resultSetData.
  8. Let result be OrdinaryObjectCreate(%Set.prototype%, « [[SetData]] »).
  9. Set result.[[SetData]] to resultSetData.
  10. Return result.

24.2.4.17 Set.prototype.values ( )

This method performs the following steps when called:

  1. Let S be the this value.
  2. Return ? CreateSetIterator(S, value).

24.2.4.18 Set.prototype [ %Symbol.iterator% ] ( )

The initial value of the %Symbol.iterator% property is %Set.prototype.values%, defined in 24.2.4.17.

24.2.4.19 Set.prototype [ %Symbol.toStringTag% ]

The initial value of the %Symbol.toStringTag% property is the String value "Set".

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: true }.

24.2.5 Properties of Set Instances

Set instances are ordinary objects that inherit properties from the Set prototype object. Set instances also have a [[SetData]] internal slot.

24.2.6 Set Iterator Objects

A Set Iterator is an ordinary object, with the structure defined below, that represents a specific iteration over some specific Set instance object. There is not a named constructor for Set Iterator objects. Instead, Set Iterator objects are created by calling certain methods of Set instance objects.

24.2.6.1 CreateSetIterator ( set, kind )

The abstract operation CreateSetIterator takes arguments set (an ECMAScript language value) and kind (key+value or value) and returns either a normal completion containing a Generator or a throw completion. It is used to create iterator objects for Set methods that return such iterators. It performs the following steps when called:

  1. Perform ? RequireInternalSlot(set, [[SetData]]).
  2. Let closure be a new Abstract Closure with no parameters that captures set and kind and performs the following steps when called:
    1. Let index be 0.
    2. Let entries be set.[[SetData]].
    3. Let numEntries be the number of elements in entries.
    4. Repeat, while index < numEntries,
      1. Let e be entries[index].
      2. Set index to index + 1.
      3. If e is not empty, then
        1. If kind is key+value, then
          1. Let result be CreateArrayFromListe, e »).
          2. Perform ? GeneratorYield(CreateIteratorResultObject(result, false)).
        2. Else,
          1. Assert: kind is value.
          2. Perform ? GeneratorYield(CreateIteratorResultObject(e, false)).
        3. NOTE: The number of elements in entries may have increased while execution of this abstract operation was paused by GeneratorYield.
        4. Set numEntries to the number of elements in entries.
    5. Return NormalCompletion(unused).
  3. Return CreateIteratorFromClosure(closure, "%SetIteratorPrototype%", %SetIteratorPrototype%).

24.2.6.2 The %SetIteratorPrototype% Object

The %SetIteratorPrototype% object:

24.2.6.2.1 %SetIteratorPrototype%.next ( )

  1. Return ? GeneratorResume(this value, empty, "%SetIteratorPrototype%").

24.2.6.2.2 %SetIteratorPrototype% [ %Symbol.toStringTag% ]

The initial value of the %Symbol.toStringTag% property is the String value "Set Iterator".

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: true }.

24.3 WeakMap Objects

WeakMaps are collections of key/value pairs where the keys are objects and/or symbols and values may be arbitrary ECMAScript language values. A WeakMap may be queried to see if it contains a key/value pair with a specific key, but no mechanism is provided for enumerating the values it holds as keys. In certain conditions, values which are not live are removed as WeakMap keys, as described in 9.9.3.

An implementation may impose an arbitrarily determined latency between the time a key/value pair of a WeakMap becomes inaccessible and the time when the key/value pair is removed from the WeakMap. If this latency was observable to ECMAScript program, it would be a source of indeterminacy that could impact program execution. For that reason, an ECMAScript implementation must not provide any means to observe a key of a WeakMap that does not require the observer to present the observed key.

WeakMaps must be implemented using either hash tables or other mechanisms that, on average, provide access times that are sublinear on the number of key/value pairs in the collection. The data structure used in this specification is only intended to describe the required observable semantics of WeakMaps. It is not intended to be a viable implementation model.

Note

WeakMap and WeakSet are intended to provide mechanisms for dynamically associating state with an object or symbol in a manner that does not “leak” memory resources if, in the absence of the WeakMap or WeakSet instance, the object or symbol otherwise became inaccessible and subject to resource reclamation by the implementation's garbage collection mechanisms. This characteristic can be achieved by using an inverted per-object/symbol mapping of WeakMap or WeakSet instances to keys. Alternatively, each WeakMap or WeakSet instance may internally store its key and value data, but this approach requires coordination between the WeakMap or WeakSet implementation and the garbage collector. The following references describe mechanism that may be useful to implementations of WeakMap and WeakSet:

Barry Hayes. 1997. Ephemerons: a new finalization mechanism. In Proceedings of the 12th ACM SIGPLAN conference on Object-oriented programming, systems, languages, and applications (OOPSLA '97), A. Michael Berman (Ed.). ACM, New York, NY, USA, 176-183, http://doi.acm.org/10.1145/263698.263733.

Alexandra Barros, Roberto Ierusalimschy, Eliminating Cycles in Weak Tables. Journal of Universal Computer Science - J.UCS, vol. 14, no. 21, pp. 3481-3497, 2008, http://www.jucs.org/jucs_14_21/eliminating_cycles_in_weak

24.3.1 The WeakMap Constructor

The WeakMap constructor:

  • is %WeakMap%.
  • is the initial value of the "WeakMap" property of the global object.
  • creates and initializes a new WeakMap when called as a constructor.
  • is not intended to be called as a function and will throw an exception when called in that manner.
  • may be used as the value in an extends clause of a class definition. Subclass constructors that intend to inherit the specified WeakMap behaviour must include a super call to the WeakMap constructor to create and initialize the subclass instance with the internal state necessary to support the WeakMap.prototype built-in methods.

24.3.1.1 WeakMap ( [ iterable ] )

This function performs the following steps when called:

  1. If NewTarget is undefined, throw a TypeError exception.
  2. Let map be ? OrdinaryCreateFromConstructor(NewTarget, "%WeakMap.prototype%", « [[WeakMapData]] »).
  3. Set map.[[WeakMapData]] to a new empty List.
  4. If iterable is either undefined or null, return map.
  5. Let adder be ? Get(map, "set").
  6. If IsCallable(adder) is false, throw a TypeError exception.
  7. Return ? AddEntriesFromIterable(map, iterable, adder).
Note

If the parameter iterable is present, it is expected to be an object that implements a %Symbol.iterator% method that returns an iterator object that produces a two element array-like object whose first element is a value that will be used as a WeakMap key and whose second element is the value to associate with that key.

24.3.2 Properties of the WeakMap Constructor

The WeakMap constructor:

  • has a [[Prototype]] internal slot whose value is %Function.prototype%.
  • has the following properties:

24.3.2.1 WeakMap.prototype

The initial value of WeakMap.prototype is the WeakMap prototype object.

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: false }.

24.3.3 Properties of the WeakMap Prototype Object

The WeakMap prototype object:

24.3.3.1 WeakMap.prototype.constructor

The initial value of WeakMap.prototype.constructor is %WeakMap%.

24.3.3.2 WeakMap.prototype.delete ( key )

This method performs the following steps when called:

  1. Let M be the this value.
  2. Perform ? RequireInternalSlot(M, [[WeakMapData]]).
  3. If CanBeHeldWeakly(key) is false, return false.
  4. For each Record { [[Key]], [[Value]] } p of M.[[WeakMapData]], do
    1. If p.[[Key]] is not empty and SameValue(p.[[Key]], key) is true, then
      1. Set p.[[Key]] to empty.
      2. Set p.[[Value]] to empty.
      3. Return true.
  5. Return false.
Note

The value empty is used as a specification device to indicate that an entry has been deleted. Actual implementations may take other actions such as physically removing the entry from internal data structures.

24.3.3.3 WeakMap.prototype.get ( key )

This method performs the following steps when called:

  1. Let M be the this value.
  2. Perform ? RequireInternalSlot(M, [[WeakMapData]]).
  3. If CanBeHeldWeakly(key) is false, return undefined.
  4. For each Record { [[Key]], [[Value]] } p of M.[[WeakMapData]], do
    1. If p.[[Key]] is not empty and SameValue(p.[[Key]], key) is true, return p.[[Value]].
  5. Return undefined.

24.3.3.4 WeakMap.prototype.has ( key )

This method performs the following steps when called:

  1. Let M be the this value.
  2. Perform ? RequireInternalSlot(M, [[WeakMapData]]).
  3. If CanBeHeldWeakly(key) is false, return false.
  4. For each Record { [[Key]], [[Value]] } p of M.[[WeakMapData]], do
    1. If p.[[Key]] is not empty and SameValue(p.[[Key]], key) is true, return true.
  5. Return false.

24.3.3.5 WeakMap.prototype.set ( key, value )

This method performs the following steps when called:

  1. Let M be the this value.
  2. Perform ? RequireInternalSlot(M, [[WeakMapData]]).
  3. If CanBeHeldWeakly(key) is false, throw a TypeError exception.
  4. For each Record { [[Key]], [[Value]] } p of M.[[WeakMapData]], do
    1. If p.[[Key]] is not empty and SameValue(p.[[Key]], key) is true, then
      1. Set p.[[Value]] to value.
      2. Return M.
  5. Let p be the Record { [[Key]]: key, [[Value]]: value }.
  6. Append p to M.[[WeakMapData]].
  7. Return M.

24.3.3.6 WeakMap.prototype [ %Symbol.toStringTag% ]

The initial value of the %Symbol.toStringTag% property is the String value "WeakMap".

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: true }.

24.3.4 Properties of WeakMap Instances

WeakMap instances are ordinary objects that inherit properties from the WeakMap prototype object. WeakMap instances also have a [[WeakMapData]] internal slot.

24.4 WeakSet Objects

WeakSets are collections of objects and/or symbols. A distinct object or symbol may only occur once as an element of a WeakSet's collection. A WeakSet may be queried to see if it contains a specific value, but no mechanism is provided for enumerating the values it holds. In certain conditions, values which are not live are removed as WeakSet elements, as described in 9.9.3.

An implementation may impose an arbitrarily determined latency between the time a value contained in a WeakSet becomes inaccessible and the time when the value is removed from the WeakSet. If this latency was observable to ECMAScript program, it would be a source of indeterminacy that could impact program execution. For that reason, an ECMAScript implementation must not provide any means to determine if a WeakSet contains a particular value that does not require the observer to present the observed value.

WeakSets must be implemented using either hash tables or other mechanisms that, on average, provide access times that are sublinear on the number of elements in the collection. The data structure used in this specification is only intended to describe the required observable semantics of WeakSets. It is not intended to be a viable implementation model.

Note

See the NOTE in 24.3.

24.4.1 The WeakSet Constructor

The WeakSet constructor:

  • is %WeakSet%.
  • is the initial value of the "WeakSet" property of the global object.
  • creates and initializes a new WeakSet when called as a constructor.
  • is not intended to be called as a function and will throw an exception when called in that manner.
  • may be used as the value in an extends clause of a class definition. Subclass constructors that intend to inherit the specified WeakSet behaviour must include a super call to the WeakSet constructor to create and initialize the subclass instance with the internal state necessary to support the WeakSet.prototype built-in methods.

24.4.1.1 WeakSet ( [ iterable ] )

This function performs the following steps when called:

  1. If NewTarget is undefined, throw a TypeError exception.
  2. Let set be ? OrdinaryCreateFromConstructor(NewTarget, "%WeakSet.prototype%", « [[WeakSetData]] »).
  3. Set set.[[WeakSetData]] to a new empty List.
  4. If iterable is either undefined or null, return set.
  5. Let adder be ? Get(set, "add").
  6. If IsCallable(adder) is false, throw a TypeError exception.
  7. Let iteratorRecord be ? GetIterator(iterable, sync).
  8. Repeat,
    1. Let next be ? IteratorStepValue(iteratorRecord).
    2. If next is done, return set.
    3. Let status be Completion(Call(adder, set, « next »)).
    4. IfAbruptCloseIterator(status, iteratorRecord).

24.4.2 Properties of the WeakSet Constructor

The WeakSet constructor:

  • has a [[Prototype]] internal slot whose value is %Function.prototype%.
  • has the following properties:

24.4.2.1 WeakSet.prototype

The initial value of WeakSet.prototype is the WeakSet prototype object.

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: false }.

24.4.3 Properties of the WeakSet Prototype Object

The WeakSet prototype object:

24.4.3.1 WeakSet.prototype.add ( value )

This method performs the following steps when called:

  1. Let S be the this value.
  2. Perform ? RequireInternalSlot(S, [[WeakSetData]]).
  3. If CanBeHeldWeakly(value) is false, throw a TypeError exception.
  4. For each element e of S.[[WeakSetData]], do
    1. If e is not empty and SameValue(e, value) is true, then
      1. Return S.
  5. Append value to S.[[WeakSetData]].
  6. Return S.

24.4.3.2 WeakSet.prototype.constructor

The initial value of WeakSet.prototype.constructor is %WeakSet%.

24.4.3.3 WeakSet.prototype.delete ( value )

This method performs the following steps when called:

  1. Let S be the this value.
  2. Perform ? RequireInternalSlot(S, [[WeakSetData]]).
  3. If CanBeHeldWeakly(value) is false, return false.
  4. For each element e of S.[[WeakSetData]], do
    1. If e is not empty and SameValue(e, value) is true, then
      1. Replace the element of S.[[WeakSetData]] whose value is e with an element whose value is empty.
      2. Return true.
  5. Return false.
Note

The value empty is used as a specification device to indicate that an entry has been deleted. Actual implementations may take other actions such as physically removing the entry from internal data structures.

24.4.3.4 WeakSet.prototype.has ( value )

This method performs the following steps when called:

  1. Let S be the this value.
  2. Perform ? RequireInternalSlot(S, [[WeakSetData]]).
  3. If CanBeHeldWeakly(value) is false, return false.
  4. For each element e of S.[[WeakSetData]], do
    1. If e is not empty and SameValue(e, value) is true, return true.
  5. Return false.

24.4.3.5 WeakSet.prototype [ %Symbol.toStringTag% ]

The initial value of the %Symbol.toStringTag% property is the String value "WeakSet".

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: true }.

24.4.4 Properties of WeakSet Instances

WeakSet instances are ordinary objects that inherit properties from the WeakSet prototype object. WeakSet instances also have a [[WeakSetData]] internal slot.

24.5 Abstract Operations for Keyed Collections

24.5.1 CanonicalizeKeyedCollectionKey ( key )

The abstract operation CanonicalizeKeyedCollectionKey takes argument key (an ECMAScript language value) and returns an ECMAScript language value. It performs the following steps when called:

  1. If key is -0𝔽, return +0𝔽.
  2. Return key.

25 Structured Data

25.1 ArrayBuffer Objects

25.1.1 Notation

The descriptions below in this section, 25.4, and 29 use the read-modify-write modification function internal data structure.

A read-modify-write modification function is a mathematical function that is represented as an abstract closure that takes two Lists of byte values as arguments and returns a List of byte values. These abstract closures satisfy all of the following properties:

  • They perform all their algorithm steps atomically.
  • Their individual algorithm steps are not observable.
Note

To aid verifying that a read-modify-write modification function's algorithm steps constitute a pure, mathematical function, the following editorial conventions are recommended:

25.1.2 Fixed-length and Resizable ArrayBuffer Objects

A fixed-length ArrayBuffer is an ArrayBuffer whose byte length cannot change after creation.

A resizable ArrayBuffer is an ArrayBuffer whose byte length may change after creation via calls to ArrayBuffer.prototype.resize ( newLength ).

The kind of ArrayBuffer object that is created depends on the arguments passed to ArrayBuffer ( length [ , options ] ).

25.1.3 Abstract Operations For ArrayBuffer Objects

25.1.3.1 AllocateArrayBuffer ( constructor, byteLength [ , maxByteLength ] )

The abstract operation AllocateArrayBuffer takes arguments constructor (a constructor) and byteLength (a non-negative integer) and optional argument maxByteLength (a non-negative integer or empty) and returns either a normal completion containing an ArrayBuffer or a throw completion. It is used to create an ArrayBuffer. It performs the following steps when called:

  1. Let slots be « [[ArrayBufferData]], [[ArrayBufferByteLength]], [[ArrayBufferDetachKey]] ».
  2. If maxByteLength is present and maxByteLength is not empty, let allocatingResizableBuffer be true; otherwise let allocatingResizableBuffer be false.
  3. If allocatingResizableBuffer is true, then
    1. If byteLength > maxByteLength, throw a RangeError exception.
    2. Append [[ArrayBufferMaxByteLength]] to slots.
  4. Let obj be ? OrdinaryCreateFromConstructor(constructor, "%ArrayBuffer.prototype%", slots).
  5. Let block be ? CreateByteDataBlock(byteLength).
  6. Set obj.[[ArrayBufferData]] to block.
  7. Set obj.[[ArrayBufferByteLength]] to byteLength.
  8. If allocatingResizableBuffer is true, then
    1. If it is not possible to create a Data Block block consisting of maxByteLength bytes, throw a RangeError exception.
    2. NOTE: Resizable ArrayBuffers are designed to be implementable with in-place growth. Implementations may throw if, for example, virtual memory cannot be reserved up front.
    3. Set obj.[[ArrayBufferMaxByteLength]] to maxByteLength.
  9. Return obj.

25.1.3.2 ArrayBufferByteLength ( arrayBuffer, order )

The abstract operation ArrayBufferByteLength takes arguments arrayBuffer (an ArrayBuffer or SharedArrayBuffer) and order (seq-cst or unordered) and returns a non-negative integer. It performs the following steps when called:

  1. If IsSharedArrayBuffer(arrayBuffer) is true and arrayBuffer has an [[ArrayBufferByteLengthData]] internal slot, then
    1. Let bufferByteLengthBlock be arrayBuffer.[[ArrayBufferByteLengthData]].
    2. Let rawLength be GetRawBytesFromSharedBlock(bufferByteLengthBlock, 0, biguint64, true, order).
    3. Let isLittleEndian be the value of the [[LittleEndian]] field of the surrounding agent's Agent Record.
    4. Return (RawBytesToNumeric(biguint64, rawLength, isLittleEndian)).
  2. Assert: IsDetachedBuffer(arrayBuffer) is false.
  3. Return arrayBuffer.[[ArrayBufferByteLength]].

25.1.3.3 ArrayBufferCopyAndDetach ( arrayBuffer, newLength, preserveResizability )

The abstract operation ArrayBufferCopyAndDetach takes arguments arrayBuffer (an ECMAScript language value), newLength (an ECMAScript language value), and preserveResizability (preserve-resizability or fixed-length) and returns either a normal completion containing an ArrayBuffer or a throw completion. It performs the following steps when called:

  1. Perform ? RequireInternalSlot(arrayBuffer, [[ArrayBufferData]]).
  2. If IsSharedArrayBuffer(arrayBuffer) is true, throw a TypeError exception.
  3. If newLength is undefined, then
    1. Let newByteLength be arrayBuffer.[[ArrayBufferByteLength]].
  4. Else,
    1. Let newByteLength be ? ToIndex(newLength).
  5. If IsDetachedBuffer(arrayBuffer) is true, throw a TypeError exception.
  6. If preserveResizability is preserve-resizability and IsFixedLengthArrayBuffer(arrayBuffer) is false, then
    1. Let newMaxByteLength be arrayBuffer.[[ArrayBufferMaxByteLength]].
  7. Else,
    1. Let newMaxByteLength be empty.
  8. If arrayBuffer.[[ArrayBufferDetachKey]] is not undefined, throw a TypeError exception.
  9. Let newBuffer be ? AllocateArrayBuffer(%ArrayBuffer%, newByteLength, newMaxByteLength).
  10. Let copyLength be min(newByteLength, arrayBuffer.[[ArrayBufferByteLength]]).
  11. Let fromBlock be arrayBuffer.[[ArrayBufferData]].
  12. Let toBlock be newBuffer.[[ArrayBufferData]].
  13. Perform CopyDataBlockBytes(toBlock, 0, fromBlock, 0, copyLength).
  14. NOTE: Neither creation of the new Data Block nor copying from the old Data Block are observable. Implementations may implement this method as a zero-copy move or a realloc.
  15. Perform ! DetachArrayBuffer(arrayBuffer).
  16. Return newBuffer.

25.1.3.4 IsDetachedBuffer ( arrayBuffer )

The abstract operation IsDetachedBuffer takes argument arrayBuffer (an ArrayBuffer or a SharedArrayBuffer) and returns a Boolean. It performs the following steps when called:

  1. If arrayBuffer.[[ArrayBufferData]] is null, return true.
  2. Return false.

25.1.3.5 DetachArrayBuffer ( arrayBuffer [ , key ] )

The abstract operation DetachArrayBuffer takes argument arrayBuffer (an ArrayBuffer) and optional argument key (anything) and returns either a normal completion containing unused or a throw completion. It performs the following steps when called:

  1. Assert: IsSharedArrayBuffer(arrayBuffer) is false.
  2. If key is not present, set key to undefined.
  3. If arrayBuffer.[[ArrayBufferDetachKey]] is not key, throw a TypeError exception.
  4. Set arrayBuffer.[[ArrayBufferData]] to null.
  5. Set arrayBuffer.[[ArrayBufferByteLength]] to 0.
  6. Return unused.
Note

Detaching an ArrayBuffer instance disassociates the Data Block used as its backing store from the instance and sets the byte length of the buffer to 0.

25.1.3.6 CloneArrayBuffer ( srcBuffer, srcByteOffset, srcLength )

The abstract operation CloneArrayBuffer takes arguments srcBuffer (an ArrayBuffer or a SharedArrayBuffer), srcByteOffset (a non-negative integer), and srcLength (a non-negative integer) and returns either a normal completion containing an ArrayBuffer or a throw completion. It creates a new ArrayBuffer whose data is a copy of srcBuffer's data over the range starting at srcByteOffset and continuing for srcLength bytes. It performs the following steps when called:

  1. Assert: IsDetachedBuffer(srcBuffer) is false.
  2. Let targetBuffer be ? AllocateArrayBuffer(%ArrayBuffer%, srcLength).
  3. Let srcBlock be srcBuffer.[[ArrayBufferData]].
  4. Let targetBlock be targetBuffer.[[ArrayBufferData]].
  5. Perform CopyDataBlockBytes(targetBlock, 0, srcBlock, srcByteOffset, srcLength).
  6. Return targetBuffer.

25.1.3.7 GetArrayBufferMaxByteLengthOption ( options )

The abstract operation GetArrayBufferMaxByteLengthOption takes argument options (an ECMAScript language value) and returns either a normal completion containing either a non-negative integer or empty, or a throw completion. It performs the following steps when called:

  1. If options is not an Object, return empty.
  2. Let maxByteLength be ? Get(options, "maxByteLength").
  3. If maxByteLength is undefined, return empty.
  4. Return ? ToIndex(maxByteLength).

25.1.3.8 HostResizeArrayBuffer ( buffer, newByteLength )

The host-defined abstract operation HostResizeArrayBuffer takes arguments buffer (an ArrayBuffer) and newByteLength (a non-negative integer) and returns either a normal completion containing either handled or unhandled, or a throw completion. It gives the host an opportunity to perform implementation-defined resizing of buffer. If the host chooses not to handle resizing of buffer, it may return unhandled for the default behaviour.

The implementation of HostResizeArrayBuffer must conform to the following requirements:

  • The abstract operation does not detach buffer.
  • If the abstract operation completes normally with handled, buffer.[[ArrayBufferByteLength]] is newByteLength.

The default implementation of HostResizeArrayBuffer is to return NormalCompletion(unhandled).

25.1.3.9 IsFixedLengthArrayBuffer ( arrayBuffer )

The abstract operation IsFixedLengthArrayBuffer takes argument arrayBuffer (an ArrayBuffer or a SharedArrayBuffer) and returns a Boolean. It performs the following steps when called:

  1. If arrayBuffer has an [[ArrayBufferMaxByteLength]] internal slot, return false.
  2. Return true.

25.1.3.10 IsUnsignedElementType ( type )

The abstract operation IsUnsignedElementType takes argument type (a TypedArray element type) and returns a Boolean. It verifies if the argument type is an unsigned TypedArray element type. It performs the following steps when called:

  1. If type is one of uint8, uint8clamped, uint16, uint32, or biguint64, return true.
  2. Return false.

25.1.3.11 IsUnclampedIntegerElementType ( type )

The abstract operation IsUnclampedIntegerElementType takes argument type (a TypedArray element type) and returns a Boolean. It verifies if the argument type is an Integer TypedArray element type not including uint8clamped. It performs the following steps when called:

  1. If type is one of int8, uint8, int16, uint16, int32, or uint32, return true.
  2. Return false.

25.1.3.12 IsBigIntElementType ( type )

The abstract operation IsBigIntElementType takes argument type (a TypedArray element type) and returns a Boolean. It verifies if the argument type is a BigInt TypedArray element type. It performs the following steps when called:

  1. If type is either biguint64 or bigint64, return true.
  2. Return false.

25.1.3.13 IsNoTearConfiguration ( type, order )

The abstract operation IsNoTearConfiguration takes arguments type (a TypedArray element type) and order (seq-cst, unordered, or init) and returns a Boolean. It performs the following steps when called:

  1. If IsUnclampedIntegerElementType(type) is true, return true.
  2. If IsBigIntElementType(type) is true and order is neither init nor unordered, return true.
  3. Return false.

25.1.3.14 RawBytesToNumeric ( type, rawBytes, isLittleEndian )

The abstract operation RawBytesToNumeric takes arguments type (a TypedArray element type), rawBytes (a List of byte values), and isLittleEndian (a Boolean) and returns a Number or a BigInt. It performs the following steps when called:

  1. Let elementSize be the Element Size value specified in Table 75 for Element Type type.
  2. If isLittleEndian is false, reverse the order of the elements of rawBytes.
  3. If type is float16, then
    1. Let value be the byte elements of rawBytes concatenated and interpreted as a little-endian bit string encoding of an IEEE 754-2019 binary16 value.
    2. If value is a NaN, return NaN.
    3. Return the Number value that corresponds to value.
  4. If type is float32, then
    1. Let value be the byte elements of rawBytes concatenated and interpreted as a little-endian bit string encoding of an IEEE 754-2019 binary32 value.
    2. If value is a NaN, return NaN.
    3. Return the Number value that corresponds to value.
  5. If type is float64, then
    1. Let value be the byte elements of rawBytes concatenated and interpreted as a little-endian bit string encoding of an IEEE 754-2019 binary64 value.
    2. If value is a NaN, return NaN.
    3. Return the Number value that corresponds to value.
  6. If IsUnsignedElementType(type) is true, then
    1. Let intValue be the byte elements of rawBytes concatenated and interpreted as a bit string encoding of an unsigned little-endian binary number.
  7. Else,
    1. Let intValue be the byte elements of rawBytes concatenated and interpreted as a bit string encoding of a binary little-endian two's complement number of bit length elementSize × 8.
  8. If IsBigIntElementType(type) is true, return the BigInt value that corresponds to intValue.
  9. Otherwise, return the Number value that corresponds to intValue.

25.1.3.15 GetRawBytesFromSharedBlock ( block, byteIndex, type, isTypedArray, order )

The abstract operation GetRawBytesFromSharedBlock takes arguments block (a Shared Data Block), byteIndex (a non-negative integer), type (a TypedArray element type), isTypedArray (a Boolean), and order (seq-cst or unordered) and returns a List of byte values. It performs the following steps when called:

  1. Let elementSize be the Element Size value specified in Table 75 for Element Type type.
  2. Let execution be the [[CandidateExecution]] field of the surrounding agent's Agent Record.
  3. Let eventsRecord be the Agent Events Record of execution.[[EventsRecords]] whose [[AgentSignifier]] is AgentSignifier().
  4. If isTypedArray is true and IsNoTearConfiguration(type, order) is true, let noTear be true; otherwise let noTear be false.
  5. Let rawValue be a List of length elementSize whose elements are nondeterministically chosen byte values.
  6. NOTE: In implementations, rawValue is the result of a non-atomic or atomic read instruction on the underlying hardware. The nondeterminism is a semantic prescription of the memory model to describe observable behaviour of hardware with weak consistency.
  7. Let readEvent be ReadSharedMemory { [[Order]]: order, [[NoTear]]: noTear, [[Block]]: block, [[ByteIndex]]: byteIndex, [[ElementSize]]: elementSize }.
  8. Append readEvent to eventsRecord.[[EventList]].
  9. Append Chosen Value Record { [[Event]]: readEvent, [[ChosenValue]]: rawValue } to execution.[[ChosenValues]].
  10. Return rawValue.

25.1.3.16 GetValueFromBuffer ( arrayBuffer, byteIndex, type, isTypedArray, order [ , isLittleEndian ] )

The abstract operation GetValueFromBuffer takes arguments arrayBuffer (an ArrayBuffer or SharedArrayBuffer), byteIndex (a non-negative integer), type (a TypedArray element type), isTypedArray (a Boolean), and order (seq-cst or unordered) and optional argument isLittleEndian (a Boolean) and returns a Number or a BigInt. It performs the following steps when called:

  1. Assert: IsDetachedBuffer(arrayBuffer) is false.
  2. Assert: There are sufficient bytes in arrayBuffer starting at byteIndex to represent a value of type.
  3. Let block be arrayBuffer.[[ArrayBufferData]].
  4. Let elementSize be the Element Size value specified in Table 75 for Element Type type.
  5. If IsSharedArrayBuffer(arrayBuffer) is true, then
    1. Assert: block is a Shared Data Block.
    2. Let rawValue be GetRawBytesFromSharedBlock(block, byteIndex, type, isTypedArray, order).
  6. Else,
    1. Let rawValue be a List whose elements are bytes from block at indices in the interval from byteIndex (inclusive) to byteIndex + elementSize (exclusive).
  7. Assert: The number of elements in rawValue is elementSize.
  8. If isLittleEndian is not present, set isLittleEndian to the value of the [[LittleEndian]] field of the surrounding agent's Agent Record.
  9. Return RawBytesToNumeric(type, rawValue, isLittleEndian).

25.1.3.17 NumericToRawBytes ( type, value, isLittleEndian )

The abstract operation NumericToRawBytes takes arguments type (a TypedArray element type), value (a Number or a BigInt), and isLittleEndian (a Boolean) and returns a List of byte values. It performs the following steps when called:

  1. If type is float16, then
    1. Let rawBytes be a List whose elements are the 2 bytes that are the result of converting value to IEEE 754-2019 binary16 format using roundTiesToEven mode. The bytes are arranged in little endian order. If value is NaN, rawBytes may be set to any implementation chosen IEEE 754-2019 binary16 format NaN encoding. An implementation must always choose the same encoding for each implementation distinguishable NaN value.
  2. Else if type is float32, then
    1. Let rawBytes be a List whose elements are the 4 bytes that are the result of converting value to IEEE 754-2019 binary32 format using roundTiesToEven mode. The bytes are arranged in little endian order. If value is NaN, rawBytes may be set to any implementation chosen IEEE 754-2019 binary32 format NaN encoding. An implementation must always choose the same encoding for each implementation distinguishable NaN value.
  3. Else if type is float64, then
    1. Let rawBytes be a List whose elements are the 8 bytes that are the IEEE 754-2019 binary64 format encoding of value. The bytes are arranged in little endian order. If value is NaN, rawBytes may be set to any implementation chosen IEEE 754-2019 binary64 format NaN encoding. An implementation must always choose the same encoding for each implementation distinguishable NaN value.
  4. Else,
    1. Let n be the Element Size value specified in Table 75 for Element Type type.
    2. Let conversionOperation be the abstract operation named in the Conversion Operation column in Table 75 for Element Type type.
    3. Let intValue be (! conversionOperation(value)).
    4. If intValue ≥ 0, then
      1. Let rawBytes be a List whose elements are the n-byte binary encoding of intValue. The bytes are ordered in little endian order.
    5. Else,
      1. Let rawBytes be a List whose elements are the n-byte binary two's complement encoding of intValue. The bytes are ordered in little endian order.
  5. If isLittleEndian is false, reverse the order of the elements of rawBytes.
  6. Return rawBytes.

25.1.3.18 SetValueInBuffer ( arrayBuffer, byteIndex, type, value, isTypedArray, order [ , isLittleEndian ] )

The abstract operation SetValueInBuffer takes arguments arrayBuffer (an ArrayBuffer or SharedArrayBuffer), byteIndex (a non-negative integer), type (a TypedArray element type), value (a Number or a BigInt), isTypedArray (a Boolean), and order (seq-cst, unordered, or init) and optional argument isLittleEndian (a Boolean) and returns unused. It performs the following steps when called:

  1. Assert: IsDetachedBuffer(arrayBuffer) is false.
  2. Assert: There are sufficient bytes in arrayBuffer starting at byteIndex to represent a value of type.
  3. Assert: value is a BigInt if IsBigIntElementType(type) is true; otherwise, value is a Number.
  4. Let block be arrayBuffer.[[ArrayBufferData]].
  5. Let elementSize be the Element Size value specified in Table 75 for Element Type type.
  6. If isLittleEndian is not present, set isLittleEndian to the value of the [[LittleEndian]] field of the surrounding agent's Agent Record.
  7. Let rawBytes be NumericToRawBytes(type, value, isLittleEndian).
  8. If IsSharedArrayBuffer(arrayBuffer) is true, then
    1. Let execution be the [[CandidateExecution]] field of the surrounding agent's Agent Record.
    2. Let eventsRecord be the Agent Events Record of execution.[[EventsRecords]] whose [[AgentSignifier]] is AgentSignifier().
    3. If isTypedArray is true and IsNoTearConfiguration(type, order) is true, let noTear be true; otherwise let noTear be false.
    4. Append WriteSharedMemory { [[Order]]: order, [[NoTear]]: noTear, [[Block]]: block, [[ByteIndex]]: byteIndex, [[ElementSize]]: elementSize, [[Payload]]: rawBytes } to eventsRecord.[[EventList]].
  9. Else,
    1. Store the individual bytes of rawBytes into block, starting at block[byteIndex].
  10. Return unused.

25.1.3.19 GetModifySetValueInBuffer ( arrayBuffer, byteIndex, type, value, op )

The abstract operation GetModifySetValueInBuffer takes arguments arrayBuffer (an ArrayBuffer or a SharedArrayBuffer), byteIndex (a non-negative integer), type (a TypedArray element type), value (a Number or a BigInt), and op (a read-modify-write modification function) and returns a Number or a BigInt. It performs the following steps when called:

  1. Assert: IsDetachedBuffer(arrayBuffer) is false.
  2. Assert: There are sufficient bytes in arrayBuffer starting at byteIndex to represent a value of type.
  3. Assert: value is a BigInt if IsBigIntElementType(type) is true; otherwise, value is a Number.
  4. Let block be arrayBuffer.[[ArrayBufferData]].
  5. Let elementSize be the Element Size value specified in Table 75 for Element Type type.
  6. Let isLittleEndian be the value of the [[LittleEndian]] field of the surrounding agent's Agent Record.
  7. Let rawBytes be NumericToRawBytes(type, value, isLittleEndian).
  8. If IsSharedArrayBuffer(arrayBuffer) is true, then
    1. Let execution be the [[CandidateExecution]] field of the surrounding agent's Agent Record.
    2. Let eventsRecord be the Agent Events Record of execution.[[EventsRecords]] whose [[AgentSignifier]] is AgentSignifier().
    3. Let rawBytesRead be a List of length elementSize whose elements are nondeterministically chosen byte values.
    4. NOTE: In implementations, rawBytesRead is the result of a load-link, of a load-exclusive, or of an operand of a read-modify-write instruction on the underlying hardware. The nondeterminism is a semantic prescription of the memory model to describe observable behaviour of hardware with weak consistency.
    5. Let rmwEvent be ReadModifyWriteSharedMemory { [[Order]]: seq-cst, [[NoTear]]: true, [[Block]]: block, [[ByteIndex]]: byteIndex, [[ElementSize]]: elementSize, [[Payload]]: rawBytes, [[ModifyOp]]: op }.
    6. Append rmwEvent to eventsRecord.[[EventList]].
    7. Append Chosen Value Record { [[Event]]: rmwEvent, [[ChosenValue]]: rawBytesRead } to execution.[[ChosenValues]].
  9. Else,
    1. Let rawBytesRead be a List of length elementSize whose elements are the sequence of elementSize bytes starting with block[byteIndex].
    2. Let rawBytesModified be op(rawBytesRead, rawBytes).
    3. Store the individual bytes of rawBytesModified into block, starting at block[byteIndex].
  10. Return RawBytesToNumeric(type, rawBytesRead, isLittleEndian).

25.1.4 The ArrayBuffer Constructor

The ArrayBuffer constructor:

  • is %ArrayBuffer%.
  • is the initial value of the "ArrayBuffer" property of the global object.
  • creates and initializes a new ArrayBuffer when called as a constructor.
  • is not intended to be called as a function and will throw an exception when called in that manner.
  • may be used as the value of an extends clause of a class definition. Subclass constructors that intend to inherit the specified ArrayBuffer behaviour must include a super call to the ArrayBuffer constructor to create and initialize subclass instances with the internal state necessary to support the ArrayBuffer.prototype built-in methods.

25.1.4.1 ArrayBuffer ( length [ , options ] )

This function performs the following steps when called:

  1. If NewTarget is undefined, throw a TypeError exception.
  2. Let byteLength be ? ToIndex(length).
  3. Let requestedMaxByteLength be ? GetArrayBufferMaxByteLengthOption(options).
  4. Return ? AllocateArrayBuffer(NewTarget, byteLength, requestedMaxByteLength).

25.1.5 Properties of the ArrayBuffer Constructor

The ArrayBuffer constructor:

  • has a [[Prototype]] internal slot whose value is %Function.prototype%.
  • has the following properties:

25.1.5.1 ArrayBuffer.isView ( arg )

This function performs the following steps when called:

  1. If arg is not an Object, return false.
  2. If arg has a [[ViewedArrayBuffer]] internal slot, return true.
  3. Return false.

25.1.5.2 ArrayBuffer.prototype

The initial value of ArrayBuffer.prototype is the ArrayBuffer prototype object.

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: false }.

25.1.5.3 get ArrayBuffer [ %Symbol.species% ]

ArrayBuffer[%Symbol.species%] is an accessor property whose set accessor function is undefined. Its get accessor function performs the following steps when called:

  1. Return the this value.

The value of the "name" property of this function is "get [Symbol.species]".

Note

ArrayBuffer.prototype.slice ( start, end ) normally uses its this value's constructor to create a derived object. However, a subclass constructor may over-ride that default behaviour for the ArrayBuffer.prototype.slice ( start, end ) method by redefining its %Symbol.species% property.

25.1.6 Properties of the ArrayBuffer Prototype Object

The ArrayBuffer prototype object:

  • is %ArrayBuffer.prototype%.
  • has a [[Prototype]] internal slot whose value is %Object.prototype%.
  • is an ordinary object.
  • does not have an [[ArrayBufferData]] or [[ArrayBufferByteLength]] internal slot.

25.1.6.1 get ArrayBuffer.prototype.byteLength

ArrayBuffer.prototype.byteLength is an accessor property whose set accessor function is undefined. Its get accessor function performs the following steps when called:

  1. Let O be the this value.
  2. Perform ? RequireInternalSlot(O, [[ArrayBufferData]]).
  3. If IsSharedArrayBuffer(O) is true, throw a TypeError exception.
  4. If IsDetachedBuffer(O) is true, return +0𝔽.
  5. Let length be O.[[ArrayBufferByteLength]].
  6. Return 𝔽(length).

25.1.6.2 ArrayBuffer.prototype.constructor

The initial value of ArrayBuffer.prototype.constructor is %ArrayBuffer%.

25.1.6.3 get ArrayBuffer.prototype.detached

ArrayBuffer.prototype.detached is an accessor property whose set accessor function is undefined. Its get accessor function performs the following steps when called:

  1. Let O be the this value.
  2. Perform ? RequireInternalSlot(O, [[ArrayBufferData]]).
  3. If IsSharedArrayBuffer(O) is true, throw a TypeError exception.
  4. Return IsDetachedBuffer(O).

25.1.6.4 get ArrayBuffer.prototype.maxByteLength

ArrayBuffer.prototype.maxByteLength is an accessor property whose set accessor function is undefined. Its get accessor function performs the following steps when called:

  1. Let O be the this value.
  2. Perform ? RequireInternalSlot(O, [[ArrayBufferData]]).
  3. If IsSharedArrayBuffer(O) is true, throw a TypeError exception.
  4. If IsDetachedBuffer(O) is true, return +0𝔽.
  5. If IsFixedLengthArrayBuffer(O) is true, then
    1. Let length be O.[[ArrayBufferByteLength]].
  6. Else,
    1. Let length be O.[[ArrayBufferMaxByteLength]].
  7. Return 𝔽(length).

25.1.6.5 get ArrayBuffer.prototype.resizable

ArrayBuffer.prototype.resizable is an accessor property whose set accessor function is undefined. Its get accessor function performs the following steps when called:

  1. Let O be the this value.
  2. Perform ? RequireInternalSlot(O, [[ArrayBufferData]]).
  3. If IsSharedArrayBuffer(O) is true, throw a TypeError exception.
  4. If IsFixedLengthArrayBuffer(O) is false, return true; otherwise return false.

25.1.6.6 ArrayBuffer.prototype.resize ( newLength )

This method performs the following steps when called:

  1. Let O be the this value.
  2. Perform ? RequireInternalSlot(O, [[ArrayBufferMaxByteLength]]).
  3. If IsSharedArrayBuffer(O) is true, throw a TypeError exception.
  4. Let newByteLength be ? ToIndex(newLength).
  5. If IsDetachedBuffer(O) is true, throw a TypeError exception.
  6. If newByteLength > O.[[ArrayBufferMaxByteLength]], throw a RangeError exception.
  7. Let hostHandled be ? HostResizeArrayBuffer(O, newByteLength).
  8. If hostHandled is handled, return undefined.
  9. Let oldBlock be O.[[ArrayBufferData]].
  10. Let newBlock be ? CreateByteDataBlock(newByteLength).
  11. Let copyLength be min(newByteLength, O.[[ArrayBufferByteLength]]).
  12. Perform CopyDataBlockBytes(newBlock, 0, oldBlock, 0, copyLength).
  13. NOTE: Neither creation of the new Data Block nor copying from the old Data Block are observable. Implementations may implement this method as in-place growth or shrinkage.
  14. Set O.[[ArrayBufferData]] to newBlock.
  15. Set O.[[ArrayBufferByteLength]] to newByteLength.
  16. Return undefined.

25.1.6.7 ArrayBuffer.prototype.slice ( start, end )

This method performs the following steps when called:

  1. Let O be the this value.
  2. Perform ? RequireInternalSlot(O, [[ArrayBufferData]]).
  3. If IsSharedArrayBuffer(O) is true, throw a TypeError exception.
  4. If IsDetachedBuffer(O) is true, throw a TypeError exception.
  5. Let len be O.[[ArrayBufferByteLength]].
  6. Let relativeStart be ? ToIntegerOrInfinity(start).
  7. If relativeStart = -∞, let first be 0.
  8. Else if relativeStart < 0, let first be max(len + relativeStart, 0).
  9. Else, let first be min(relativeStart, len).
  10. If end is undefined, let relativeEnd be len; else let relativeEnd be ? ToIntegerOrInfinity(end).
  11. If relativeEnd = -∞, let final be 0.
  12. Else if relativeEnd < 0, let final be max(len + relativeEnd, 0).
  13. Else, let final be min(relativeEnd, len).
  14. Let newLen be max(final - first, 0).
  15. Let ctor be ? SpeciesConstructor(O, %ArrayBuffer%).
  16. Let new be ? Construct(ctor, « 𝔽(newLen) »).
  17. Perform ? RequireInternalSlot(new, [[ArrayBufferData]]).
  18. If IsSharedArrayBuffer(new) is true, throw a TypeError exception.
  19. If IsDetachedBuffer(new) is true, throw a TypeError exception.
  20. If SameValue(new, O) is true, throw a TypeError exception.
  21. If new.[[ArrayBufferByteLength]] < newLen, throw a TypeError exception.
  22. NOTE: Side-effects of the above steps may have detached or resized O.
  23. If IsDetachedBuffer(O) is true, throw a TypeError exception.
  24. Let fromBuf be O.[[ArrayBufferData]].
  25. Let toBuf be new.[[ArrayBufferData]].
  26. Let currentLen be O.[[ArrayBufferByteLength]].
  27. If first < currentLen, then
    1. Let count be min(newLen, currentLen - first).
    2. Perform CopyDataBlockBytes(toBuf, 0, fromBuf, first, count).
  28. Return new.

25.1.6.8 ArrayBuffer.prototype.transfer ( [ newLength ] )

This method performs the following steps when called:

  1. Let O be the this value.
  2. Return ? ArrayBufferCopyAndDetach(O, newLength, preserve-resizability).

25.1.6.9 ArrayBuffer.prototype.transferToFixedLength ( [ newLength ] )

This method performs the following steps when called:

  1. Let O be the this value.
  2. Return ? ArrayBufferCopyAndDetach(O, newLength, fixed-length).

25.1.6.10 ArrayBuffer.prototype [ %Symbol.toStringTag% ]

The initial value of the %Symbol.toStringTag% property is the String value "ArrayBuffer".

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: true }.

25.1.7 Properties of ArrayBuffer Instances

ArrayBuffer instances inherit properties from the ArrayBuffer prototype object. ArrayBuffer instances each have an [[ArrayBufferData]] internal slot, an [[ArrayBufferByteLength]] internal slot, and an [[ArrayBufferDetachKey]] internal slot. ArrayBuffer instances which are resizable each have an [[ArrayBufferMaxByteLength]] internal slot.

ArrayBuffer instances whose [[ArrayBufferData]] is null are considered to be detached and all operators to access or modify data contained in the ArrayBuffer instance will fail.

ArrayBuffer instances whose [[ArrayBufferDetachKey]] is set to a value other than undefined need to have all DetachArrayBuffer calls passing that same "detach key" as an argument, otherwise a TypeError will result. This internal slot is only ever set by certain embedding environments, not by algorithms in this specification.

25.1.8 Resizable ArrayBuffer Guidelines

Note 1

The following are guidelines for ECMAScript programmers working with resizable ArrayBuffer.

We recommend that programs be tested in their deployment environments where possible. The amount of available physical memory differs greatly between hardware devices. Similarly, virtual memory subsystems also differ greatly between hardware devices as well as operating systems. An application that runs without out-of-memory errors on a 64-bit desktop web browser could run out of memory on a 32-bit mobile web browser.

When choosing a value for the "maxByteLength" option for resizable ArrayBuffer, we recommend that the smallest possible size for the application be chosen. We recommend that "maxByteLength" does not exceed 1,073,741,824 (230 bytes or 1GiB).

Please note that successfully constructing a resizable ArrayBuffer for a particular maximum size does not guarantee that future resizes will succeed.

Note 2

The following are guidelines for ECMAScript implementers implementing resizable ArrayBuffer.

Resizable ArrayBuffer can be implemented as copying upon resize, as in-place growth via reserving virtual memory up front, or as a combination of both for different values of the constructor's "maxByteLength" option.

If a host is multi-tenanted (i.e. it runs many ECMAScript applications simultaneously), such as a web browser, and its implementations choose to implement in-place growth by reserving virtual memory, we recommend that both 32-bit and 64-bit implementations throw for values of "maxByteLength" ≥ 1GiB to 1.5GiB. This is to reduce the likelihood a single application can exhaust the virtual memory address space and to reduce interoperability risk.

If a host does not have virtual memory, such as those running on embedded devices without an MMU, or if a host only implements resizing by copying, it may accept any Number value for the "maxByteLength" option. However, we recommend a RangeError be thrown if a memory block of the requested size can never be allocated. For example, if the requested size is greater than the maximum amount of usable memory on the device.

25.2 SharedArrayBuffer Objects

25.2.1 Fixed-length and Growable SharedArrayBuffer Objects

A fixed-length SharedArrayBuffer is a SharedArrayBuffer whose byte length cannot change after creation.

A growable SharedArrayBuffer is a SharedArrayBuffer whose byte length may increase after creation via calls to SharedArrayBuffer.prototype.grow ( newLength ).

The kind of SharedArrayBuffer object that is created depends on the arguments passed to SharedArrayBuffer ( length [ , options ] ).

25.2.2 Abstract Operations for SharedArrayBuffer Objects

25.2.2.1 AllocateSharedArrayBuffer ( constructor, byteLength [ , maxByteLength ] )

The abstract operation AllocateSharedArrayBuffer takes arguments constructor (a constructor) and byteLength (a non-negative integer) and optional argument maxByteLength (a non-negative integer or empty) and returns either a normal completion containing a SharedArrayBuffer or a throw completion. It is used to create a SharedArrayBuffer. It performs the following steps when called:

  1. Let slots be « [[ArrayBufferData]] ».
  2. If maxByteLength is present and maxByteLength is not empty, let allocatingGrowableBuffer be true; otherwise let allocatingGrowableBuffer be false.
  3. If allocatingGrowableBuffer is true, then
    1. If byteLength > maxByteLength, throw a RangeError exception.
    2. Append [[ArrayBufferByteLengthData]] and [[ArrayBufferMaxByteLength]] to slots.
  4. Else,
    1. Append [[ArrayBufferByteLength]] to slots.
  5. Let obj be ? OrdinaryCreateFromConstructor(constructor, "%SharedArrayBuffer.prototype%", slots).
  6. If allocatingGrowableBuffer is true, let allocLength be maxByteLength; otherwise let allocLength be byteLength.
  7. Let block be ? CreateSharedByteDataBlock(allocLength).
  8. Set obj.[[ArrayBufferData]] to block.
  9. If allocatingGrowableBuffer is true, then
    1. Assert: byteLengthmaxByteLength.
    2. Let byteLengthBlock be ? CreateSharedByteDataBlock(8).
    3. Perform SetValueInBuffer(byteLengthBlock, 0, biguint64, (byteLength), true, seq-cst).
    4. Set obj.[[ArrayBufferByteLengthData]] to byteLengthBlock.
    5. Set obj.[[ArrayBufferMaxByteLength]] to maxByteLength.
  10. Else,
    1. Set obj.[[ArrayBufferByteLength]] to byteLength.
  11. Return obj.

25.2.2.2 IsSharedArrayBuffer ( obj )

The abstract operation IsSharedArrayBuffer takes argument obj (an ArrayBuffer or a SharedArrayBuffer) and returns a Boolean. It tests whether an object is an ArrayBuffer, a SharedArrayBuffer, or a subtype of either. It performs the following steps when called:

  1. Let bufferData be obj.[[ArrayBufferData]].
  2. If bufferData is null, return false.
  3. If bufferData is a Data Block, return false.
  4. Assert: bufferData is a Shared Data Block.
  5. Return true.

25.2.2.3 HostGrowSharedArrayBuffer ( buffer, newByteLength )

The host-defined abstract operation HostGrowSharedArrayBuffer takes arguments buffer (a SharedArrayBuffer) and newByteLength (a non-negative integer) and returns either a normal completion containing either handled or unhandled, or a throw completion. It gives the host an opportunity to perform implementation-defined growing of buffer. If the host chooses not to handle growing of buffer, it may return unhandled for the default behaviour.

The implementation of HostGrowSharedArrayBuffer must conform to the following requirements:

  • If the abstract operation does not complete normally with unhandled, and newByteLength < the current byte length of the buffer or newByteLength > buffer.[[ArrayBufferMaxByteLength]], throw a RangeError exception.
  • Let isLittleEndian be the value of the [[LittleEndian]] field of the surrounding agent's Agent Record. If the abstract operation completes normally with handled, a WriteSharedMemory or ReadModifyWriteSharedMemory event whose [[Order]] is seq-cst, [[Payload]] is NumericToRawBytes(biguint64, newByteLength, isLittleEndian), [[Block]] is buffer.[[ArrayBufferByteLengthData]], [[ByteIndex]] is 0, and [[ElementSize]] is 8 is added to the surrounding agent's candidate execution such that racing calls to SharedArrayBuffer.prototype.grow are not "lost", i.e. silently do nothing.
Note

The second requirement above is intentionally vague about how or when the current byte length of buffer is read. Because the byte length must be updated via an atomic read-modify-write operation on the underlying hardware, architectures that use load-link/store-conditional or load-exclusive/store-exclusive instruction pairs may wish to keep the paired instructions close in the instruction stream. As such, SharedArrayBuffer.prototype.grow itself does not perform bounds checking on newByteLength before calling HostGrowSharedArrayBuffer, nor is there a requirement on when the current byte length is read.

This is in contrast with HostResizeArrayBuffer, which is guaranteed that the value of newByteLength is ≥ 0 and ≤ buffer.[[ArrayBufferMaxByteLength]].

The default implementation of HostGrowSharedArrayBuffer is to return NormalCompletion(unhandled).

25.2.3 The SharedArrayBuffer Constructor

The SharedArrayBuffer constructor:

  • is %SharedArrayBuffer%.
  • is the initial value of the "SharedArrayBuffer" property of the global object, if that property is present (see below).
  • creates and initializes a new SharedArrayBuffer when called as a constructor.
  • is not intended to be called as a function and will throw an exception when called in that manner.
  • may be used as the value of an extends clause of a class definition. Subclass constructors that intend to inherit the specified SharedArrayBuffer behaviour must include a super call to the SharedArrayBuffer constructor to create and initialize subclass instances with the internal state necessary to support the SharedArrayBuffer.prototype built-in methods.

Whenever a host does not provide concurrent access to SharedArrayBuffers it may omit the "SharedArrayBuffer" property of the global object.

Note

Unlike an ArrayBuffer, a SharedArrayBuffer cannot become detached, and its internal [[ArrayBufferData]] slot is never null.

25.2.3.1 SharedArrayBuffer ( length [ , options ] )

This function performs the following steps when called:

  1. If NewTarget is undefined, throw a TypeError exception.
  2. Let byteLength be ? ToIndex(length).
  3. Let requestedMaxByteLength be ? GetArrayBufferMaxByteLengthOption(options).
  4. Return ? AllocateSharedArrayBuffer(NewTarget, byteLength, requestedMaxByteLength).

25.2.4 Properties of the SharedArrayBuffer Constructor

The SharedArrayBuffer constructor:

  • has a [[Prototype]] internal slot whose value is %Function.prototype%.
  • has the following properties:

25.2.4.1 SharedArrayBuffer.prototype

The initial value of SharedArrayBuffer.prototype is the SharedArrayBuffer prototype object.

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: false }.

25.2.4.2 get SharedArrayBuffer [ %Symbol.species% ]

SharedArrayBuffer[%Symbol.species%] is an accessor property whose set accessor function is undefined. Its get accessor function performs the following steps when called:

  1. Return the this value.

The value of the "name" property of this function is "get [Symbol.species]".

25.2.5 Properties of the SharedArrayBuffer Prototype Object

The SharedArrayBuffer prototype object:

  • is %SharedArrayBuffer.prototype%.
  • has a [[Prototype]] internal slot whose value is %Object.prototype%.
  • is an ordinary object.
  • does not have an [[ArrayBufferData]] or [[ArrayBufferByteLength]] internal slot.

25.2.5.1 get SharedArrayBuffer.prototype.byteLength

SharedArrayBuffer.prototype.byteLength is an accessor property whose set accessor function is undefined. Its get accessor function performs the following steps when called:

  1. Let O be the this value.
  2. Perform ? RequireInternalSlot(O, [[ArrayBufferData]]).
  3. If IsSharedArrayBuffer(O) is false, throw a TypeError exception.
  4. Let length be ArrayBufferByteLength(O, seq-cst).
  5. Return 𝔽(length).

25.2.5.2 SharedArrayBuffer.prototype.constructor

The initial value of SharedArrayBuffer.prototype.constructor is %SharedArrayBuffer%.

25.2.5.3 SharedArrayBuffer.prototype.grow ( newLength )

This method performs the following steps when called:

  1. Let O be the this value.
  2. Perform ? RequireInternalSlot(O, [[ArrayBufferMaxByteLength]]).
  3. If IsSharedArrayBuffer(O) is false, throw a TypeError exception.
  4. Let newByteLength be ? ToIndex(newLength).
  5. Let hostHandled be ? HostGrowSharedArrayBuffer(O, newByteLength).
  6. If hostHandled is handled, return undefined.
  7. Let isLittleEndian be the value of the [[LittleEndian]] field of the surrounding agent's Agent Record.
  8. Let byteLengthBlock be O.[[ArrayBufferByteLengthData]].
  9. Let currentByteLengthRawBytes be GetRawBytesFromSharedBlock(byteLengthBlock, 0, biguint64, true, seq-cst).
  10. Let newByteLengthRawBytes be NumericToRawBytes(biguint64, (newByteLength), isLittleEndian).
  11. Repeat,
    1. NOTE: This is a compare-and-exchange loop to ensure that parallel, racing grows of the same buffer are totally ordered, are not lost, and do not silently do nothing. The loop exits if it was able to attempt to grow uncontended.
    2. Let currentByteLength be (RawBytesToNumeric(biguint64, currentByteLengthRawBytes, isLittleEndian)).
    3. If newByteLength = currentByteLength, return undefined.
    4. If newByteLength < currentByteLength or newByteLength > O.[[ArrayBufferMaxByteLength]], throw a RangeError exception.
    5. Let byteLengthDelta be newByteLength - currentByteLength.
    6. If it is impossible to create a new Shared Data Block value consisting of byteLengthDelta bytes, throw a RangeError exception.
    7. NOTE: No new Shared Data Block is constructed and used here. The observable behaviour of growable SharedArrayBuffers is specified by allocating a max-sized Shared Data Block at construction time, and this step captures the requirement that implementations that run out of memory must throw a RangeError.
    8. Let readByteLengthRawBytes be AtomicCompareExchangeInSharedBlock(byteLengthBlock, 0, 8, currentByteLengthRawBytes, newByteLengthRawBytes).
    9. If ByteListEqual(readByteLengthRawBytes, currentByteLengthRawBytes) is true, return undefined.
    10. Set currentByteLengthRawBytes to readByteLengthRawBytes.
Note

Spurious failures of the compare-exchange to update the length are prohibited. If the bounds checking for the new length passes and the implementation is not out of memory, a ReadModifyWriteSharedMemory event (i.e. a successful compare-exchange) is always added into the candidate execution.

Parallel calls to SharedArrayBuffer.prototype.grow are totally ordered. For example, consider two racing calls: sab.grow(10) and sab.grow(20). One of the two calls is guaranteed to win the race. The call to sab.grow(10) will never shrink sab even if sab.grow(20) happened first; in that case it will instead throw a RangeError.

25.2.5.4 get SharedArrayBuffer.prototype.growable

SharedArrayBuffer.prototype.growable is an accessor property whose set accessor function is undefined. Its get accessor function performs the following steps when called:

  1. Let O be the this value.
  2. Perform ? RequireInternalSlot(O, [[ArrayBufferData]]).
  3. If IsSharedArrayBuffer(O) is false, throw a TypeError exception.
  4. If IsFixedLengthArrayBuffer(O) is false, return true; otherwise return false.

25.2.5.5 get SharedArrayBuffer.prototype.maxByteLength

SharedArrayBuffer.prototype.maxByteLength is an accessor property whose set accessor function is undefined. Its get accessor function performs the following steps when called:

  1. Let O be the this value.
  2. Perform ? RequireInternalSlot(O, [[ArrayBufferData]]).
  3. If IsSharedArrayBuffer(O) is false, throw a TypeError exception.
  4. If IsFixedLengthArrayBuffer(O) is true, then
    1. Let length be O.[[ArrayBufferByteLength]].
  5. Else,
    1. Let length be O.[[ArrayBufferMaxByteLength]].
  6. Return 𝔽(length).

25.2.5.6 SharedArrayBuffer.prototype.slice ( start, end )

This method performs the following steps when called:

  1. Let O be the this value.
  2. Perform ? RequireInternalSlot(O, [[ArrayBufferData]]).
  3. If IsSharedArrayBuffer(O) is false, throw a TypeError exception.
  4. Let len be ArrayBufferByteLength(O, seq-cst).
  5. Let relativeStart be ? ToIntegerOrInfinity(start).
  6. If relativeStart = -∞, let first be 0.
  7. Else if relativeStart < 0, let first be max(len + relativeStart, 0).
  8. Else, let first be min(relativeStart, len).
  9. If end is undefined, let relativeEnd be len; else let relativeEnd be ? ToIntegerOrInfinity(end).
  10. If relativeEnd = -∞, let final be 0.
  11. Else if relativeEnd < 0, let final be max(len + relativeEnd, 0).
  12. Else, let final be min(relativeEnd, len).
  13. Let newLen be max(final - first, 0).
  14. Let ctor be ? SpeciesConstructor(O, %SharedArrayBuffer%).
  15. Let new be ? Construct(ctor, « 𝔽(newLen) »).
  16. Perform ? RequireInternalSlot(new, [[ArrayBufferData]]).
  17. If IsSharedArrayBuffer(new) is false, throw a TypeError exception.
  18. If new.[[ArrayBufferData]] is O.[[ArrayBufferData]], throw a TypeError exception.
  19. If ArrayBufferByteLength(new, seq-cst) < newLen, throw a TypeError exception.
  20. Let fromBuf be O.[[ArrayBufferData]].
  21. Let toBuf be new.[[ArrayBufferData]].
  22. Perform CopyDataBlockBytes(toBuf, 0, fromBuf, first, newLen).
  23. Return new.

25.2.5.7 SharedArrayBuffer.prototype [ %Symbol.toStringTag% ]

The initial value of the %Symbol.toStringTag% property is the String value "SharedArrayBuffer".

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: true }.

25.2.6 Properties of SharedArrayBuffer Instances

SharedArrayBuffer instances inherit properties from the SharedArrayBuffer prototype object. SharedArrayBuffer instances each have an [[ArrayBufferData]] internal slot. SharedArrayBuffer instances which are not growable each have an [[ArrayBufferByteLength]] internal slot. SharedArrayBuffer instances which are growable each have an [[ArrayBufferByteLengthData]] internal slot and an [[ArrayBufferMaxByteLength]] internal slot.

Note

SharedArrayBuffer instances, unlike ArrayBuffer instances, are never detached.

25.2.7 Growable SharedArrayBuffer Guidelines

Note 1

The following are guidelines for ECMAScript programmers working with growable SharedArrayBuffer.

We recommend that programs be tested in their deployment environments where possible. The amount of available physical memory differ greatly between hardware devices. Similarly, virtual memory subsystems also differ greatly between hardware devices as well as operating systems. An application that runs without out-of-memory errors on a 64-bit desktop web browser could run out of memory on a 32-bit mobile web browser.

When choosing a value for the "maxByteLength" option for growable SharedArrayBuffer, we recommend that the smallest possible size for the application be chosen. We recommend that "maxByteLength" does not exceed 1073741824, or 1GiB.

Please note that successfully constructing a growable SharedArrayBuffer for a particular maximum size does not guarantee that future grows will succeed.

Not all loads of a growable SharedArrayBuffer's length are synchronizing seq-cst loads. Loads of the length that are for bounds-checking of an integer-indexed property access, e.g. u8[idx], are not synchronizing. In general, in the absence of explicit synchronization, one property access being in-bound does not imply a subsequent property access in the same agent is also in-bound. In contrast, explicit loads of the length via the length and byteLength getters on SharedArrayBuffer, %TypedArray%.prototype, and DataView.prototype are synchronizing. Loads of the length that are performed by built-in methods to check if a TypedArray is entirely out-of-bounds are also synchronizing.

Note 2

The following are guidelines for ECMAScript implementers implementing growable SharedArrayBuffer.

We recommend growable SharedArrayBuffer be implemented as in-place growth via reserving virtual memory up front.

Because grow operations can happen in parallel with memory accesses on a growable SharedArrayBuffer, the constraints of the memory model require that even unordered accesses do not "tear" (bits of their values will not be mixed). In practice, this means the underlying data block of a growable SharedArrayBuffer cannot be grown by being copied without stopping the world. We do not recommend stopping the world as an implementation strategy because it introduces a serialization point and is slow.

Grown memory must appear zeroed from the moment of its creation, including to any racy accesses in parallel. This can be accomplished via zero-filled-on-demand virtual memory pages, or careful synchronization if manually zeroing memory.

Integer-indexed property access on TypedArray views of growable SharedArrayBuffers is intended to be optimizable similarly to access on TypedArray views of non-growable SharedArrayBuffers, because integer-indexed property loads on are not synchronizing on the underlying buffer's length (see programmer guidelines above). For example, bounds checks for property accesses may still be hoisted out of loops.

In practice it is difficult to implement growable SharedArrayBuffer by copying on hosts that do not have virtual memory, such as those running on embedded devices without an MMU. Memory usage behaviour of growable SharedArrayBuffers on such hosts may significantly differ from that of hosts with virtual memory. Such hosts should clearly communicate memory usage expectations to users.

25.3 DataView Objects

25.3.1 Abstract Operations For DataView Objects

25.3.1.1 DataView With Buffer Witness Records

A DataView With Buffer Witness Record is a Record value used to encapsulate a DataView along with a cached byte length of the viewed buffer. It is used to help ensure there is a single shared memory read event of the byte length data block when the viewed buffer is a growable SharedArrayBuffers.

DataView With Buffer Witness Records have the fields listed in Table 77.

Table 77: DataView With Buffer Witness Record Fields
Field Name Value Meaning
[[Object]] a DataView The DataView object whose buffer's byte length is loaded.
[[CachedBufferByteLength]] a non-negative integer or detached The byte length of the object's [[ViewedArrayBuffer]] when the Record was created.

25.3.1.2 MakeDataViewWithBufferWitnessRecord ( obj, order )

The abstract operation MakeDataViewWithBufferWitnessRecord takes arguments obj (a DataView) and order (seq-cst or unordered) and returns a DataView With Buffer Witness Record. It performs the following steps when called:

  1. Let buffer be obj.[[ViewedArrayBuffer]].
  2. If IsDetachedBuffer(buffer) is true, then
    1. Let byteLength be detached.
  3. Else,
    1. Let byteLength be ArrayBufferByteLength(buffer, order).
  4. Return the DataView With Buffer Witness Record { [[Object]]: obj, [[CachedBufferByteLength]]: byteLength }.

25.3.1.3 GetViewByteLength ( viewRecord )

The abstract operation GetViewByteLength takes argument viewRecord (a DataView With Buffer Witness Record) and returns a non-negative integer. It performs the following steps when called:

  1. Assert: IsViewOutOfBounds(viewRecord) is false.
  2. Let view be viewRecord.[[Object]].
  3. If view.[[ByteLength]] is not auto, return view.[[ByteLength]].
  4. Assert: IsFixedLengthArrayBuffer(view.[[ViewedArrayBuffer]]) is false.
  5. Let byteOffset be view.[[ByteOffset]].
  6. Let byteLength be viewRecord.[[CachedBufferByteLength]].
  7. Assert: byteLength is not detached.
  8. Return byteLength - byteOffset.

25.3.1.4 IsViewOutOfBounds ( viewRecord )

The abstract operation IsViewOutOfBounds takes argument viewRecord (a DataView With Buffer Witness Record) and returns a Boolean. It performs the following steps when called:

  1. Let view be viewRecord.[[Object]].
  2. Let bufferByteLength be viewRecord.[[CachedBufferByteLength]].
  3. Assert: IsDetachedBuffer(view.[[ViewedArrayBuffer]]) is true if and only if bufferByteLength is detached.
  4. If bufferByteLength is detached, return true.
  5. Let byteOffsetStart be view.[[ByteOffset]].
  6. If view.[[ByteLength]] is auto, then
    1. Let byteOffsetEnd be bufferByteLength.
  7. Else,
    1. Let byteOffsetEnd be byteOffsetStart + view.[[ByteLength]].
  8. If byteOffsetStart > bufferByteLength or byteOffsetEnd > bufferByteLength, return true.
  9. NOTE: 0-length DataViews are not considered out-of-bounds.
  10. Return false.

25.3.1.5 GetViewValue ( view, requestIndex, isLittleEndian, type )

The abstract operation GetViewValue takes arguments view (an ECMAScript language value), requestIndex (an ECMAScript language value), isLittleEndian (an ECMAScript language value), and type (a TypedArray element type) and returns either a normal completion containing either a Number or a BigInt, or a throw completion. It is used by functions on DataView instances to retrieve values from the view's buffer. It performs the following steps when called:

  1. Perform ? RequireInternalSlot(view, [[DataView]]).
  2. Assert: view has a [[ViewedArrayBuffer]] internal slot.
  3. Let getIndex be ? ToIndex(requestIndex).
  4. Set isLittleEndian to ToBoolean(isLittleEndian).
  5. Let viewOffset be view.[[ByteOffset]].
  6. Let viewRecord be MakeDataViewWithBufferWitnessRecord(view, unordered).
  7. NOTE: Bounds checking is not a synchronizing operation when view's backing buffer is a growable SharedArrayBuffer.
  8. If IsViewOutOfBounds(viewRecord) is true, throw a TypeError exception.
  9. Let viewSize be GetViewByteLength(viewRecord).
  10. Let elementSize be the Element Size value specified in Table 75 for Element Type type.
  11. If getIndex + elementSize > viewSize, throw a RangeError exception.
  12. Let bufferIndex be getIndex + viewOffset.
  13. Return GetValueFromBuffer(view.[[ViewedArrayBuffer]], bufferIndex, type, false, unordered, isLittleEndian).

25.3.1.6 SetViewValue ( view, requestIndex, isLittleEndian, type, value )

The abstract operation SetViewValue takes arguments view (an ECMAScript language value), requestIndex (an ECMAScript language value), isLittleEndian (an ECMAScript language value), type (a TypedArray element type), and value (an ECMAScript language value) and returns either a normal completion containing undefined or a throw completion. It is used by functions on DataView instances to store values into the view's buffer. It performs the following steps when called:

  1. Perform ? RequireInternalSlot(view, [[DataView]]).
  2. Assert: view has a [[ViewedArrayBuffer]] internal slot.
  3. Let getIndex be ? ToIndex(requestIndex).
  4. If IsBigIntElementType(type) is true, let numberValue be ? ToBigInt(value).
  5. Otherwise, let numberValue be ? ToNumber(value).
  6. Set isLittleEndian to ToBoolean(isLittleEndian).
  7. Let viewOffset be view.[[ByteOffset]].
  8. Let viewRecord be MakeDataViewWithBufferWitnessRecord(view, unordered).
  9. NOTE: Bounds checking is not a synchronizing operation when view's backing buffer is a growable SharedArrayBuffer.
  10. If IsViewOutOfBounds(viewRecord) is true, throw a TypeError exception.
  11. Let viewSize be GetViewByteLength(viewRecord).
  12. Let elementSize be the Element Size value specified in Table 75 for Element Type type.
  13. If getIndex + elementSize > viewSize, throw a RangeError exception.
  14. Let bufferIndex be getIndex + viewOffset.
  15. Perform SetValueInBuffer(view.[[ViewedArrayBuffer]], bufferIndex, type, numberValue, false, unordered, isLittleEndian).
  16. Return undefined.

25.3.2 The DataView Constructor

The DataView constructor:

  • is %DataView%.
  • is the initial value of the "DataView" property of the global object.
  • creates and initializes a new DataView when called as a constructor.
  • is not intended to be called as a function and will throw an exception when called in that manner.
  • may be used as the value of an extends clause of a class definition. Subclass constructors that intend to inherit the specified DataView behaviour must include a super call to the DataView constructor to create and initialize subclass instances with the internal state necessary to support the DataView.prototype built-in methods.

25.3.2.1 DataView ( buffer [ , byteOffset [ , byteLength ] ] )

This function performs the following steps when called:

  1. If NewTarget is undefined, throw a TypeError exception.
  2. Perform ? RequireInternalSlot(buffer, [[ArrayBufferData]]).
  3. Let offset be ? ToIndex(byteOffset).
  4. If IsDetachedBuffer(buffer) is true, throw a TypeError exception.
  5. Let bufferByteLength be ArrayBufferByteLength(buffer, seq-cst).
  6. If offset > bufferByteLength, throw a RangeError exception.
  7. Let bufferIsFixedLength be IsFixedLengthArrayBuffer(buffer).
  8. If byteLength is undefined, then
    1. If bufferIsFixedLength is true, then
      1. Let viewByteLength be bufferByteLength - offset.
    2. Else,
      1. Let viewByteLength be auto.
  9. Else,
    1. Let viewByteLength be ? ToIndex(byteLength).
    2. If offset + viewByteLength > bufferByteLength, throw a RangeError exception.
  10. Let O be ? OrdinaryCreateFromConstructor(NewTarget, "%DataView.prototype%", « [[DataView]], [[ViewedArrayBuffer]], [[ByteLength]], [[ByteOffset]] »).
  11. If IsDetachedBuffer(buffer) is true, throw a TypeError exception.
  12. Set bufferByteLength to ArrayBufferByteLength(buffer, seq-cst).
  13. If offset > bufferByteLength, throw a RangeError exception.
  14. If byteLength is not undefined, then
    1. If offset + viewByteLength > bufferByteLength, throw a RangeError exception.
  15. Set O.[[ViewedArrayBuffer]] to buffer.
  16. Set O.[[ByteLength]] to viewByteLength.
  17. Set O.[[ByteOffset]] to offset.
  18. Return O.

25.3.3 Properties of the DataView Constructor

The DataView constructor:

  • has a [[Prototype]] internal slot whose value is %Function.prototype%.
  • has the following properties:

25.3.3.1 DataView.prototype

The initial value of DataView.prototype is the DataView prototype object.

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: false }.

25.3.4 Properties of the DataView Prototype Object

The DataView prototype object:

  • is %DataView.prototype%.
  • has a [[Prototype]] internal slot whose value is %Object.prototype%.
  • is an ordinary object.
  • does not have a [[DataView]], [[ViewedArrayBuffer]], [[ByteLength]], or [[ByteOffset]] internal slot.

25.3.4.1 get DataView.prototype.buffer

DataView.prototype.buffer is an accessor property whose set accessor function is undefined. Its get accessor function performs the following steps when called:

  1. Let O be the this value.
  2. Perform ? RequireInternalSlot(O, [[DataView]]).
  3. Assert: O has a [[ViewedArrayBuffer]] internal slot.
  4. Let buffer be O.[[ViewedArrayBuffer]].
  5. Return buffer.

25.3.4.2 get DataView.prototype.byteLength

DataView.prototype.byteLength is an accessor property whose set accessor function is undefined. Its get accessor function performs the following steps when called:

  1. Let O be the this value.
  2. Perform ? RequireInternalSlot(O, [[DataView]]).
  3. Assert: O has a [[ViewedArrayBuffer]] internal slot.
  4. Let viewRecord be MakeDataViewWithBufferWitnessRecord(O, seq-cst).
  5. If IsViewOutOfBounds(viewRecord) is true, throw a TypeError exception.
  6. Let size be GetViewByteLength(viewRecord).
  7. Return 𝔽(size).

25.3.4.3 get DataView.prototype.byteOffset

DataView.prototype.byteOffset is an accessor property whose set accessor function is undefined. Its get accessor function performs the following steps when called:

  1. Let O be the this value.
  2. Perform ? RequireInternalSlot(O, [[DataView]]).
  3. Assert: O has a [[ViewedArrayBuffer]] internal slot.
  4. Let viewRecord be MakeDataViewWithBufferWitnessRecord(O, seq-cst).
  5. If IsViewOutOfBounds(viewRecord) is true, throw a TypeError exception.
  6. Let offset be O.[[ByteOffset]].
  7. Return 𝔽(offset).

25.3.4.4 DataView.prototype.constructor

The initial value of DataView.prototype.constructor is %DataView%.

25.3.4.5 DataView.prototype.getBigInt64 ( byteOffset [ , littleEndian ] )

This method performs the following steps when called:

  1. Let view be the this value.
  2. Return ? GetViewValue(view, byteOffset, littleEndian, bigint64).

25.3.4.6 DataView.prototype.getBigUint64 ( byteOffset [ , littleEndian ] )

This method performs the following steps when called:

  1. Let view be the this value.
  2. Return ? GetViewValue(view, byteOffset, littleEndian, biguint64).

25.3.4.7 DataView.prototype.getFloat16 ( byteOffset [ , littleEndian ] )

This method performs the following steps when called:

  1. Let view be the this value.
  2. If littleEndian is not present, set littleEndian to false.
  3. Return ? GetViewValue(view, byteOffset, littleEndian, float16).

25.3.4.8 DataView.prototype.getFloat32 ( byteOffset [ , littleEndian ] )

This method performs the following steps when called:

  1. Let view be the this value.
  2. If littleEndian is not present, set littleEndian to false.
  3. Return ? GetViewValue(view, byteOffset, littleEndian, float32).

25.3.4.9 DataView.prototype.getFloat64 ( byteOffset [ , littleEndian ] )

This method performs the following steps when called:

  1. Let view be the this value.
  2. If littleEndian is not present, set littleEndian to false.
  3. Return ? GetViewValue(view, byteOffset, littleEndian, float64).

25.3.4.10 DataView.prototype.getInt8 ( byteOffset )

This method performs the following steps when called:

  1. Let view be the this value.
  2. Return ? GetViewValue(view, byteOffset, true, int8).

25.3.4.11 DataView.prototype.getInt16 ( byteOffset [ , littleEndian ] )

This method performs the following steps when called:

  1. Let view be the this value.
  2. If littleEndian is not present, set littleEndian to false.
  3. Return ? GetViewValue(view, byteOffset, littleEndian, int16).

25.3.4.12 DataView.prototype.getInt32 ( byteOffset [ , littleEndian ] )

This method performs the following steps when called:

  1. Let view be the this value.
  2. If littleEndian is not present, set littleEndian to false.
  3. Return ? GetViewValue(view, byteOffset, littleEndian, int32).

25.3.4.13 DataView.prototype.getUint8 ( byteOffset )

This method performs the following steps when called:

  1. Let view be the this value.
  2. Return ? GetViewValue(view, byteOffset, true, uint8).

25.3.4.14 DataView.prototype.getUint16 ( byteOffset [ , littleEndian ] )

This method performs the following steps when called:

  1. Let view be the this value.
  2. If littleEndian is not present, set littleEndian to false.
  3. Return ? GetViewValue(view, byteOffset, littleEndian, uint16).

25.3.4.15 DataView.prototype.getUint32 ( byteOffset [ , littleEndian ] )

This method performs the following steps when called:

  1. Let view be the this value.
  2. If littleEndian is not present, set littleEndian to false.
  3. Return ? GetViewValue(view, byteOffset, littleEndian, uint32).

25.3.4.16 DataView.prototype.setBigInt64 ( byteOffset, value [ , littleEndian ] )

This method performs the following steps when called:

  1. Let view be the this value.
  2. Return ? SetViewValue(view, byteOffset, littleEndian, bigint64, value).

25.3.4.17 DataView.prototype.setBigUint64 ( byteOffset, value [ , littleEndian ] )

This method performs the following steps when called:

  1. Let view be the this value.
  2. Return ? SetViewValue(view, byteOffset, littleEndian, biguint64, value).

25.3.4.18 DataView.prototype.setFloat16 ( byteOffset, value [ , littleEndian ] )

This method performs the following steps when called:

  1. Let view be the this value.
  2. If littleEndian is not present, set littleEndian to false.
  3. Return ? SetViewValue(view, byteOffset, littleEndian, float16, value).

25.3.4.19 DataView.prototype.setFloat32 ( byteOffset, value [ , littleEndian ] )

This method performs the following steps when called:

  1. Let view be the this value.
  2. If littleEndian is not present, set littleEndian to false.
  3. Return ? SetViewValue(view, byteOffset, littleEndian, float32, value).

25.3.4.20 DataView.prototype.setFloat64 ( byteOffset, value [ , littleEndian ] )

This method performs the following steps when called:

  1. Let view be the this value.
  2. If littleEndian is not present, set littleEndian to false.
  3. Return ? SetViewValue(view, byteOffset, littleEndian, float64, value).

25.3.4.21 DataView.prototype.setInt8 ( byteOffset, value )

This method performs the following steps when called:

  1. Let view be the this value.
  2. Return ? SetViewValue(view, byteOffset, true, int8, value).

25.3.4.22 DataView.prototype.setInt16 ( byteOffset, value [ , littleEndian ] )

This method performs the following steps when called:

  1. Let view be the this value.
  2. If littleEndian is not present, set littleEndian to false.
  3. Return ? SetViewValue(view, byteOffset, littleEndian, int16, value).

25.3.4.23 DataView.prototype.setInt32 ( byteOffset, value [ , littleEndian ] )

This method performs the following steps when called:

  1. Let view be the this value.
  2. If littleEndian is not present, set littleEndian to false.
  3. Return ? SetViewValue(view, byteOffset, littleEndian, int32, value).

25.3.4.24 DataView.prototype.setUint8 ( byteOffset, value )

This method performs the following steps when called:

  1. Let view be the this value.
  2. Return ? SetViewValue(view, byteOffset, true, uint8, value).

25.3.4.25 DataView.prototype.setUint16 ( byteOffset, value [ , littleEndian ] )

This method performs the following steps when called:

  1. Let view be the this value.
  2. If littleEndian is not present, set littleEndian to false.
  3. Return ? SetViewValue(view, byteOffset, littleEndian, uint16, value).

25.3.4.26 DataView.prototype.setUint32 ( byteOffset, value [ , littleEndian ] )

This method performs the following steps when called:

  1. Let view be the this value.
  2. If littleEndian is not present, set littleEndian to false.
  3. Return ? SetViewValue(view, byteOffset, littleEndian, uint32, value).

25.3.4.27 DataView.prototype [ %Symbol.toStringTag% ]

The initial value of the %Symbol.toStringTag% property is the String value "DataView".

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: true }.

25.3.5 Properties of DataView Instances

DataView instances are ordinary objects that inherit properties from the DataView prototype object. DataView instances each have [[DataView]], [[ViewedArrayBuffer]], [[ByteLength]], and [[ByteOffset]] internal slots.

Note

The value of the [[DataView]] internal slot is not used within this specification. The simple presence of that internal slot is used within the specification to identify objects created using the DataView constructor.

25.4 The Atomics Object

The Atomics object:

  • is %Atomics%.
  • is the initial value of the "Atomics" property of the global object.
  • is an ordinary object.
  • has a [[Prototype]] internal slot whose value is %Object.prototype%.
  • does not have a [[Construct]] internal method; it cannot be used as a constructor with the new operator.
  • does not have a [[Call]] internal method; it cannot be invoked as a function.

The Atomics object provides functions that operate indivisibly (atomically) on shared memory array cells as well as functions that let agents wait for and dispatch primitive events. When used with discipline, the Atomics functions allow multi-agent programs that communicate through shared memory to execute in a well-understood order even on parallel CPUs. The rules that govern shared-memory communication are provided by the memory model, defined below.

Note

For informative guidelines for programming and implementing shared memory in ECMAScript, please see the notes at the end of the memory model section.

25.4.1 Waiter Record

A Waiter Record is a Record value used to denote a particular call to Atomics.wait or Atomics.waitAsync.

A Waiter Record has fields listed in Table 78.

Table 78: Waiter Record Fields
Field Name Value Meaning
[[AgentSignifier]] an agent signifier The agent that called Atomics.wait or Atomics.waitAsync.
[[PromiseCapability]] a PromiseCapability Record or blocking If denoting a call to Atomics.waitAsync, the resulting promise, otherwise blocking.
[[TimeoutTime]] a non-negative extended mathematical value The earliest time by which timeout may be triggered; computed using time values.
[[Result]] "ok" or "timed-out" The return value of the call.

25.4.2 WaiterList Records

A WaiterList Record is used to explain waiting and notification of agents via Atomics.wait, Atomics.waitAsync, and Atomics.notify.

A WaiterList Record has fields listed in Table 79.

Table 79: WaiterList Record Fields
Field Name Value Meaning
[[Waiters]] a List of Waiter Records The calls to Atomics.wait or Atomics.waitAsync that are waiting on the location with which this WaiterList is associated.
[[MostRecentLeaveEvent]] a Synchronize event or empty The event of the most recent leaving of its critical section, or empty if its critical section has never been entered.

There can be multiple Waiter Records in a WaiterList with the same agent signifier.

The agent cluster has a store of WaiterList Records; the store is indexed by (block, i), where block is a Shared Data Block and i a byte offset into the memory of block. WaiterList Records are agent-independent: a lookup in the store of WaiterList Records by (block, i) will result in the same WaiterList Record in any agent in the agent cluster.

Each WaiterList Record has a critical section that controls exclusive access to that WaiterList Record during evaluation. Only a single agent may enter a WaiterList Record's critical section at one time. Entering and leaving a WaiterList Record's critical section is controlled by the abstract operations EnterCriticalSection and LeaveCriticalSection. Operations on a WaiterList Record—adding and removing waiting agents, traversing the list of agents, suspending and notifying agents on the list, setting and retrieving the Synchronize event—may only be performed by agents that have entered the WaiterList Record's critical section.

25.4.3 Abstract Operations for Atomics

25.4.3.1 ValidateIntegerTypedArray ( typedArray, waitable )

The abstract operation ValidateIntegerTypedArray takes arguments typedArray (an ECMAScript language value) and waitable (a Boolean) and returns either a normal completion containing a TypedArray With Buffer Witness Record, or a throw completion. It performs the following steps when called:

  1. Let taRecord be ? ValidateTypedArray(typedArray, unordered).
  2. NOTE: Bounds checking is not a synchronizing operation when typedArray's backing buffer is a growable SharedArrayBuffer.
  3. If waitable is true, then
    1. If typedArray.[[TypedArrayName]] is neither "Int32Array" nor "BigInt64Array", throw a TypeError exception.
  4. Else,
    1. Let type be TypedArrayElementType(typedArray).
    2. If IsUnclampedIntegerElementType(type) is false and IsBigIntElementType(type) is false, throw a TypeError exception.
  5. Return taRecord.

25.4.3.2 ValidateAtomicAccess ( taRecord, requestIndex )

The abstract operation ValidateAtomicAccess takes arguments taRecord (a TypedArray With Buffer Witness Record) and requestIndex (an ECMAScript language value) and returns either a normal completion containing an integer or a throw completion. It performs the following steps when called:

  1. Let length be TypedArrayLength(taRecord).
  2. Let accessIndex be ? ToIndex(requestIndex).
  3. Assert: accessIndex ≥ 0.
  4. If accessIndexlength, throw a RangeError exception.
  5. Let typedArray be taRecord.[[Object]].
  6. Let elementSize be TypedArrayElementSize(typedArray).
  7. Let offset be typedArray.[[ByteOffset]].
  8. Return (accessIndex × elementSize) + offset.

25.4.3.3 ValidateAtomicAccessOnIntegerTypedArray ( typedArray, requestIndex )

The abstract operation ValidateAtomicAccessOnIntegerTypedArray takes arguments typedArray (an ECMAScript language value) and requestIndex (an ECMAScript language value) and returns either a normal completion containing an integer or a throw completion. It performs the following steps when called:

  1. Let taRecord be ? ValidateIntegerTypedArray(typedArray, false).
  2. Return ? ValidateAtomicAccess(taRecord, requestIndex).

25.4.3.4 RevalidateAtomicAccess ( typedArray, byteIndexInBuffer )

The abstract operation RevalidateAtomicAccess takes arguments typedArray (a TypedArray) and byteIndexInBuffer (an integer) and returns either a normal completion containing unused or a throw completion. This operation revalidates the index within the backing buffer for atomic operations after all argument coercions are performed in Atomics methods, as argument coercions can have arbitrary side effects, which could cause the buffer to become out of bounds. This operation does not throw when typedArray's backing buffer is a SharedArrayBuffer. It performs the following steps when called:

  1. Let taRecord be MakeTypedArrayWithBufferWitnessRecord(typedArray, unordered).
  2. NOTE: Bounds checking is not a synchronizing operation when typedArray's backing buffer is a growable SharedArrayBuffer.
  3. If IsTypedArrayOutOfBounds(taRecord) is true, throw a TypeError exception.
  4. Assert: byteIndexInBuffertypedArray.[[ByteOffset]].
  5. If byteIndexInBuffertaRecord.[[CachedBufferByteLength]], throw a RangeError exception.
  6. Return unused.

25.4.3.5 GetWaiterList ( block, i )

The abstract operation GetWaiterList takes arguments block (a Shared Data Block) and i (a non-negative integer that is evenly divisible by 4) and returns a WaiterList Record. It performs the following steps when called:

  1. Assert: i and i + 3 are valid byte offsets within the memory of block.
  2. Return the WaiterList Record that is referenced by the pair (block, i).

25.4.3.6 EnterCriticalSection ( WL )

The abstract operation EnterCriticalSection takes argument WL (a WaiterList Record) and returns unused. It performs the following steps when called:

  1. Assert: The surrounding agent is not in the critical section for any WaiterList Record.
  2. Wait until no agent is in the critical section for WL, then enter the critical section for WL (without allowing any other agent to enter).
  3. If WL.[[MostRecentLeaveEvent]] is not empty, then
    1. NOTE: A WL whose critical section has been entered at least once has a Synchronize event set by LeaveCriticalSection.
    2. Let execution be the [[CandidateExecution]] field of the surrounding agent's Agent Record.
    3. Let eventsRecord be the Agent Events Record of execution.[[EventsRecords]] whose [[AgentSignifier]] is AgentSignifier().
    4. Let enterEvent be a new Synchronize event.
    5. Append enterEvent to eventsRecord.[[EventList]].
    6. Append (WL.[[MostRecentLeaveEvent]], enterEvent) to eventsRecord.[[AgentSynchronizesWith]].
  4. Return unused.

EnterCriticalSection has contention when an agent attempting to enter the critical section must wait for another agent to leave it. When there is no contention, FIFO order of EnterCriticalSection calls is observable. When there is contention, an implementation may choose an arbitrary order but may not cause an agent to wait indefinitely.

25.4.3.7 LeaveCriticalSection ( WL )

The abstract operation LeaveCriticalSection takes argument WL (a WaiterList Record) and returns unused. It performs the following steps when called:

  1. Assert: The surrounding agent is in the critical section for WL.
  2. Let execution be the [[CandidateExecution]] field of the surrounding agent's Agent Record.
  3. Let eventsRecord be the Agent Events Record of execution.[[EventsRecords]] whose [[AgentSignifier]] is AgentSignifier().
  4. Let leaveEvent be a new Synchronize event.
  5. Append leaveEvent to eventsRecord.[[EventList]].
  6. Set WL.[[MostRecentLeaveEvent]] to leaveEvent.
  7. Leave the critical section for WL.
  8. Return unused.

25.4.3.8 AddWaiter ( WL, waiterRecord )

The abstract operation AddWaiter takes arguments WL (a WaiterList Record) and waiterRecord (a Waiter Record) and returns unused. It performs the following steps when called:

  1. Assert: The surrounding agent is in the critical section for WL.
  2. Assert: There is no Waiter Record in WL.[[Waiters]] whose [[PromiseCapability]] field is waiterRecord.[[PromiseCapability]] and whose [[AgentSignifier]] field is waiterRecord.[[AgentSignifier]].
  3. Append waiterRecord to WL.[[Waiters]].
  4. Return unused.

25.4.3.9 RemoveWaiter ( WL, waiterRecord )

The abstract operation RemoveWaiter takes arguments WL (a WaiterList Record) and waiterRecord (a Waiter Record) and returns unused. It performs the following steps when called:

  1. Assert: The surrounding agent is in the critical section for WL.
  2. Assert: WL.[[Waiters]] contains waiterRecord.
  3. Remove waiterRecord from WL.[[Waiters]].
  4. Return unused.

25.4.3.10 RemoveWaiters ( WL, c )

The abstract operation RemoveWaiters takes arguments WL (a WaiterList Record) and c (a non-negative integer or +∞) and returns a List of Waiter Records. It performs the following steps when called:

  1. Assert: The surrounding agent is in the critical section for WL.
  2. Let len be the number of elements in WL.[[Waiters]].
  3. Let n be min(c, len).
  4. Let L be a List whose elements are the first n elements of WL.[[Waiters]].
  5. Remove the first n elements of WL.[[Waiters]].
  6. Return L.

25.4.3.11 SuspendThisAgent ( WL, waiterRecord )

The abstract operation SuspendThisAgent takes arguments WL (a WaiterList Record) and waiterRecord (a Waiter Record) and returns unused. It performs the following steps when called:

  1. Assert: The surrounding agent is in the critical section for WL.
  2. Assert: WL.[[Waiters]] contains waiterRecord.
  3. Let thisAgent be AgentSignifier().
  4. Assert: waiterRecord.[[AgentSignifier]] is thisAgent.
  5. Assert: waiterRecord.[[PromiseCapability]] is blocking.
  6. Assert: AgentCanSuspend() is true.
  7. Perform LeaveCriticalSection(WL) and suspend the surrounding agent until the time is waiterRecord.[[TimeoutTime]], performing the combined operation in such a way that a notification that arrives after the critical section is exited but before the suspension takes effect is not lost. The surrounding agent can only wake from suspension due to a timeout or due to another agent calling NotifyWaiter with arguments WL and thisAgent (i.e. via a call to Atomics.notify).
  8. Perform EnterCriticalSection(WL).
  9. Return unused.

25.4.3.12 NotifyWaiter ( WL, waiterRecord )

The abstract operation NotifyWaiter takes arguments WL (a WaiterList Record) and waiterRecord (a Waiter Record) and returns unused. It performs the following steps when called:

  1. Assert: The surrounding agent is in the critical section for WL.
  2. If waiterRecord.[[PromiseCapability]] is blocking, then
    1. Wake the agent whose signifier is waiterRecord.[[AgentSignifier]] from suspension.
    2. NOTE: This causes the agent to resume execution in SuspendThisAgent.
  3. Else if AgentSignifier() is waiterRecord.[[AgentSignifier]], then
    1. Let promiseCapability be waiterRecord.[[PromiseCapability]].
    2. Perform ! Call(promiseCapability.[[Resolve]], undefined, « waiterRecord.[[Result]] »).
  4. Else,
    1. Perform EnqueueResolveInAgentJob(waiterRecord.[[AgentSignifier]], waiterRecord.[[PromiseCapability]], waiterRecord.[[Result]]).
  5. Return unused.
Note

An agent must not access another agent's promise capability in any capacity beyond passing it to the host.

25.4.3.13 EnqueueResolveInAgentJob ( agentSignifier, promiseCapability, resolution )

The abstract operation EnqueueResolveInAgentJob takes arguments agentSignifier (an agent signifier), promiseCapability (a PromiseCapability Record), and resolution ("ok" or "timed-out") and returns unused. It performs the following steps when called:

  1. Let resolveJob be a new Job Abstract Closure with no parameters that captures agentSignifier, promiseCapability, and resolution and performs the following steps when called:
    1. Assert: AgentSignifier() is agentSignifier.
    2. Perform ! Call(promiseCapability.[[Resolve]], undefined, « resolution »).
    3. Return unused.
  2. Let realmInTargetAgent be ! GetFunctionRealm(promiseCapability.[[Resolve]]).
  3. Assert: agentSignifier is realmInTargetAgent.[[AgentSignifier]].
  4. Perform HostEnqueueGenericJob(resolveJob, realmInTargetAgent).
  5. Return unused.

25.4.3.14 DoWait ( mode, typedArray, index, value, timeout )

The abstract operation DoWait takes arguments mode (sync or async), typedArray (an ECMAScript language value), index (an ECMAScript language value), value (an ECMAScript language value), and timeout (an ECMAScript language value) and returns either a normal completion containing either an Object, "not-equal", "timed-out", or "ok", or a throw completion. It performs the following steps when called:

  1. Let taRecord be ? ValidateIntegerTypedArray(typedArray, true).
  2. Let buffer be taRecord.[[Object]].[[ViewedArrayBuffer]].
  3. If IsSharedArrayBuffer(buffer) is false, throw a TypeError exception.
  4. Let i be ? ValidateAtomicAccess(taRecord, index).
  5. Let arrayTypeName be typedArray.[[TypedArrayName]].
  6. If arrayTypeName is "BigInt64Array", let v be ? ToBigInt64(value).
  7. Else, let v be ? ToInt32(value).
  8. Let q be ? ToNumber(timeout).
  9. If q is either NaN or +∞𝔽, let t be +∞; else if q is -∞𝔽, let t be 0; else let t be max((q), 0).
  10. If mode is sync and AgentCanSuspend() is false, throw a TypeError exception.
  11. Let block be buffer.[[ArrayBufferData]].
  12. Let offset be typedArray.[[ByteOffset]].
  13. Let byteIndexInBuffer be (i × 4) + offset.
  14. Let WL be GetWaiterList(block, byteIndexInBuffer).
  15. If mode is sync, then
    1. Let promiseCapability be blocking.
    2. Let resultObject be undefined.
  16. Else,
    1. Let promiseCapability be ! NewPromiseCapability(%Promise%).
    2. Let resultObject be OrdinaryObjectCreate(%Object.prototype%).
  17. Perform EnterCriticalSection(WL).
  18. Let elementType be TypedArrayElementType(typedArray).
  19. Let w be GetValueFromBuffer(buffer, byteIndexInBuffer, elementType, true, seq-cst).
  20. If vw, then
    1. Perform LeaveCriticalSection(WL).
    2. If mode is sync, return "not-equal".
    3. Perform ! CreateDataPropertyOrThrow(resultObject, "async", false).
    4. Perform ! CreateDataPropertyOrThrow(resultObject, "value", "not-equal").
    5. Return resultObject.
  21. If t = 0 and mode is async, then
    1. NOTE: There is no special handling of synchronous immediate timeouts. Asynchronous immediate timeouts have special handling in order to fail fast and avoid unnecessary Promise jobs.
    2. Perform LeaveCriticalSection(WL).
    3. Perform ! CreateDataPropertyOrThrow(resultObject, "async", false).
    4. Perform ! CreateDataPropertyOrThrow(resultObject, "value", "timed-out").
    5. Return resultObject.
  22. Let thisAgent be AgentSignifier().
  23. Let now be the time value (UTC) identifying the current time.
  24. Let additionalTimeout be an implementation-defined non-negative mathematical value.
  25. Let timeoutTime be (now) + t + additionalTimeout.
  26. NOTE: When t is +∞, timeoutTime is also +∞.
  27. Let waiterRecord be a new Waiter Record { [[AgentSignifier]]: thisAgent, [[PromiseCapability]]: promiseCapability, [[TimeoutTime]]: timeoutTime, [[Result]]: "ok" }.
  28. Perform AddWaiter(WL, waiterRecord).
  29. If mode is sync, then
    1. Perform SuspendThisAgent(WL, waiterRecord).
  30. Else if timeoutTime is finite, then
    1. Perform EnqueueAtomicsWaitAsyncTimeoutJob(WL, waiterRecord).
  31. Perform LeaveCriticalSection(WL).
  32. If mode is sync, return waiterRecord.[[Result]].
  33. Perform ! CreateDataPropertyOrThrow(resultObject, "async", true).
  34. Perform ! CreateDataPropertyOrThrow(resultObject, "value", promiseCapability.[[Promise]]).
  35. Return resultObject.
Note

additionalTimeout allows implementations to pad timeouts as necessary, such as for reducing power consumption or coarsening timer resolution to mitigate timing attacks. This value may differ from call to call of DoWait.

25.4.3.15 EnqueueAtomicsWaitAsyncTimeoutJob ( WL, waiterRecord )

The abstract operation EnqueueAtomicsWaitAsyncTimeoutJob takes arguments WL (a WaiterList Record) and waiterRecord (a Waiter Record) and returns unused. It performs the following steps when called:

  1. Let timeoutJob be a new Job Abstract Closure with no parameters that captures WL and waiterRecord and performs the following steps when called:
    1. Perform EnterCriticalSection(WL).
    2. If WL.[[Waiters]] contains waiterRecord, then
      1. Let timeOfJobExecution be the time value (UTC) identifying the current time.
      2. Assert: (timeOfJobExecution) ≥ waiterRecord.[[TimeoutTime]] (ignoring potential non-monotonicity of time values).
      3. Set waiterRecord.[[Result]] to "timed-out".
      4. Perform RemoveWaiter(WL, waiterRecord).
      5. Perform NotifyWaiter(WL, waiterRecord).
    3. Perform LeaveCriticalSection(WL).
    4. Return unused.
  2. Let now be the time value (UTC) identifying the current time.
  3. Let currentRealm be the current Realm Record.
  4. Perform HostEnqueueTimeoutJob(timeoutJob, currentRealm, 𝔽(waiterRecord.[[TimeoutTime]]) - now).
  5. Return unused.

25.4.3.16 AtomicCompareExchangeInSharedBlock ( block, byteIndexInBuffer, elementSize, expectedBytes, replacementBytes )

The abstract operation AtomicCompareExchangeInSharedBlock takes arguments block (a Shared Data Block), byteIndexInBuffer (an integer), elementSize (a non-negative integer), expectedBytes (a List of byte values), and replacementBytes (a List of byte values) and returns a List of byte values. It performs the following steps when called:

  1. Let execution be the [[CandidateExecution]] field of the surrounding agent's Agent Record.
  2. Let eventsRecord be the Agent Events Record of execution.[[EventsRecords]] whose [[AgentSignifier]] is AgentSignifier().
  3. Let rawBytesRead be a List of length elementSize whose elements are nondeterministically chosen byte values.
  4. NOTE: In implementations, rawBytesRead is the result of a load-link, of a load-exclusive, or of an operand of a read-modify-write instruction on the underlying hardware. The nondeterminism is a semantic prescription of the memory model to describe observable behaviour of hardware with weak consistency.
  5. NOTE: The comparison of the expected value and the read value is performed outside of the read-modify-write modification function to avoid needlessly strong synchronization when the expected value is not equal to the read value.
  6. If ByteListEqual(rawBytesRead, expectedBytes) is true, then
    1. Let second be a new read-modify-write modification function with parameters (oldBytes, newBytes) that captures nothing and performs the following steps atomically when called:
      1. Return newBytes.
    2. Let event be ReadModifyWriteSharedMemory { [[Order]]: seq-cst, [[NoTear]]: true, [[Block]]: block, [[ByteIndex]]: byteIndexInBuffer, [[ElementSize]]: elementSize, [[Payload]]: replacementBytes, [[ModifyOp]]: second }.
  7. Else,
    1. Let event be ReadSharedMemory { [[Order]]: seq-cst, [[NoTear]]: true, [[Block]]: block, [[ByteIndex]]: byteIndexInBuffer, [[ElementSize]]: elementSize }.
  8. Append event to eventsRecord.[[EventList]].
  9. Append Chosen Value Record { [[Event]]: event, [[ChosenValue]]: rawBytesRead } to execution.[[ChosenValues]].
  10. Return rawBytesRead.

25.4.3.17 AtomicReadModifyWrite ( typedArray, index, value, op )

The abstract operation AtomicReadModifyWrite takes arguments typedArray (an ECMAScript language value), index (an ECMAScript language value), value (an ECMAScript language value), and op (a read-modify-write modification function) and returns either a normal completion containing either a Number or a BigInt, or a throw completion. op takes two List of byte values arguments and returns a List of byte values. This operation atomically loads a value, combines it with another value, and stores the combination. It returns the loaded value. It performs the following steps when called:

  1. Let byteIndexInBuffer be ? ValidateAtomicAccessOnIntegerTypedArray(typedArray, index).
  2. If typedArray.[[ContentType]] is bigint, let v be ? ToBigInt(value).
  3. Otherwise, let v be 𝔽(? ToIntegerOrInfinity(value)).
  4. Perform ? RevalidateAtomicAccess(typedArray, byteIndexInBuffer).
  5. Let buffer be typedArray.[[ViewedArrayBuffer]].
  6. Let elementType be TypedArrayElementType(typedArray).
  7. Return GetModifySetValueInBuffer(buffer, byteIndexInBuffer, elementType, v, op).

25.4.3.18 ByteListBitwiseOp ( op, xBytes, yBytes )

The abstract operation ByteListBitwiseOp takes arguments op (&, ^, or |), xBytes (a List of byte values), and yBytes (a List of byte values) and returns a List of byte values. The operation atomically performs a bitwise operation on all byte values of the arguments and returns a List of byte values. It performs the following steps when called:

  1. Assert: xBytes and yBytes have the same number of elements.
  2. Let result be a new empty List.
  3. Let i be 0.
  4. For each element xByte of xBytes, do
    1. Let yByte be yBytes[i].
    2. If op is &, then
      1. Let resultByte be the result of applying the bitwise AND operation to xByte and yByte.
    3. Else if op is ^, then
      1. Let resultByte be the result of applying the bitwise exclusive OR (XOR) operation to xByte and yByte.
    4. Else,
      1. Assert: op is |.
      2. Let resultByte be the result of applying the bitwise inclusive OR operation to xByte and yByte.
    5. Set i to i + 1.
    6. Append resultByte to result.
  5. Return result.

25.4.3.19 ByteListEqual ( xBytes, yBytes )

The abstract operation ByteListEqual takes arguments xBytes (a List of byte values) and yBytes (a List of byte values) and returns a Boolean. It performs the following steps when called:

  1. If xBytes and yBytes do not have the same number of elements, return false.
  2. Let i be 0.
  3. For each element xByte of xBytes, do
    1. Let yByte be yBytes[i].
    2. If xByteyByte, return false.
    3. Set i to i + 1.
  4. Return true.

25.4.4 Atomics.add ( typedArray, index, value )

This function performs the following steps when called:

  1. Let add be a new read-modify-write modification function with parameters (xBytes, yBytes) that captures typedArray and performs the following steps atomically when called:
    1. Let type be TypedArrayElementType(typedArray).
    2. Let isLittleEndian be the value of the [[LittleEndian]] field of the surrounding agent's Agent Record.
    3. Let x be RawBytesToNumeric(type, xBytes, isLittleEndian).
    4. Let y be RawBytesToNumeric(type, yBytes, isLittleEndian).
    5. If x is a Number, then
      1. Let sum be Number::add(x, y).
    6. Else,
      1. Assert: x is a BigInt.
      2. Let sum be BigInt::add(x, y).
    7. Let sumBytes be NumericToRawBytes(type, sum, isLittleEndian).
    8. Assert: sumBytes, xBytes, and yBytes have the same number of elements.
    9. Return sumBytes.
  2. Return ? AtomicReadModifyWrite(typedArray, index, value, add).

25.4.5 Atomics.and ( typedArray, index, value )

This function performs the following steps when called:

  1. Let and be a new read-modify-write modification function with parameters (xBytes, yBytes) that captures nothing and performs the following steps atomically when called:
    1. Return ByteListBitwiseOp(&, xBytes, yBytes).
  2. Return ? AtomicReadModifyWrite(typedArray, index, value, and).

25.4.6 Atomics.compareExchange ( typedArray, index, expectedValue, replacementValue )

This function performs the following steps when called:

  1. Let byteIndexInBuffer be ? ValidateAtomicAccessOnIntegerTypedArray(typedArray, index).
  2. Let buffer be typedArray.[[ViewedArrayBuffer]].
  3. Let block be buffer.[[ArrayBufferData]].
  4. If typedArray.[[ContentType]] is bigint, then
    1. Let expected be ? ToBigInt(expectedValue).
    2. Let replacement be ? ToBigInt(replacementValue).
  5. Else,
    1. Let expected be 𝔽(? ToIntegerOrInfinity(expectedValue)).
    2. Let replacement be 𝔽(? ToIntegerOrInfinity(replacementValue)).
  6. Perform ? RevalidateAtomicAccess(typedArray, byteIndexInBuffer).
  7. Let elementType be TypedArrayElementType(typedArray).
  8. Let elementSize be TypedArrayElementSize(typedArray).
  9. Let isLittleEndian be the value of the [[LittleEndian]] field of the surrounding agent's Agent Record.
  10. Let expectedBytes be NumericToRawBytes(elementType, expected, isLittleEndian).
  11. Let replacementBytes be NumericToRawBytes(elementType, replacement, isLittleEndian).
  12. If IsSharedArrayBuffer(buffer) is true, then
    1. Let rawBytesRead be AtomicCompareExchangeInSharedBlock(block, byteIndexInBuffer, elementSize, expectedBytes, replacementBytes).
  13. Else,
    1. Let rawBytesRead be a List of length elementSize whose elements are the sequence of elementSize bytes starting with block[byteIndexInBuffer].
    2. If ByteListEqual(rawBytesRead, expectedBytes) is true, then
      1. Store the individual bytes of replacementBytes into block, starting at block[byteIndexInBuffer].
  14. Return RawBytesToNumeric(elementType, rawBytesRead, isLittleEndian).

25.4.7 Atomics.exchange ( typedArray, index, value )

This function performs the following steps when called:

  1. Let second be a new read-modify-write modification function with parameters (oldBytes, newBytes) that captures nothing and performs the following steps atomically when called:
    1. Return newBytes.
  2. Return ? AtomicReadModifyWrite(typedArray, index, value, second).

25.4.8 Atomics.isLockFree ( size )

This function performs the following steps when called:

  1. Let n be ? ToIntegerOrInfinity(size).
  2. Let AR be the Agent Record of the surrounding agent.
  3. If n = 1, return AR.[[IsLockFree1]].
  4. If n = 2, return AR.[[IsLockFree2]].
  5. If n = 4, return true.
  6. If n = 8, return AR.[[IsLockFree8]].
  7. Return false.
Note

This function is an optimization primitive. The intuition is that if the atomic step of an atomic primitive (compareExchange, load, store, add, sub, and, or, xor, or exchange) on a datum of size n bytes will be performed without the surrounding agent acquiring a lock outside the n bytes comprising the datum, then Atomics.isLockFree(n) will return true. High-performance algorithms will use this function to determine whether to use locks or atomic operations in critical sections. If an atomic primitive is not lock-free then it is often more efficient for an algorithm to provide its own locking.

Atomics.isLockFree(4) always returns true as that can be supported on all known relevant hardware. Being able to assume this will generally simplify programs.

Regardless of the value returned by this function, all atomic operations are guaranteed to be atomic. For example, they will never have a visible operation take place in the middle of the operation (e.g., "tearing").

25.4.9 Atomics.load ( typedArray, index )

This function performs the following steps when called:

  1. Let byteIndexInBuffer be ? ValidateAtomicAccessOnIntegerTypedArray(typedArray, index).
  2. Perform ? RevalidateAtomicAccess(typedArray, byteIndexInBuffer).
  3. Let buffer be typedArray.[[ViewedArrayBuffer]].
  4. Let elementType be TypedArrayElementType(typedArray).
  5. Return GetValueFromBuffer(buffer, byteIndexInBuffer, elementType, true, seq-cst).

25.4.10 Atomics.or ( typedArray, index, value )

This function performs the following steps when called:

  1. Let or be a new read-modify-write modification function with parameters (xBytes, yBytes) that captures nothing and performs the following steps atomically when called:
    1. Return ByteListBitwiseOp(|, xBytes, yBytes).
  2. Return ? AtomicReadModifyWrite(typedArray, index, value, or).

25.4.11 Atomics.store ( typedArray, index, value )

This function performs the following steps when called:

  1. Let byteIndexInBuffer be ? ValidateAtomicAccessOnIntegerTypedArray(typedArray, index).
  2. If typedArray.[[ContentType]] is bigint, let v be ? ToBigInt(value).
  3. Otherwise, let v be 𝔽(? ToIntegerOrInfinity(value)).
  4. Perform ? RevalidateAtomicAccess(typedArray, byteIndexInBuffer).
  5. Let buffer be typedArray.[[ViewedArrayBuffer]].
  6. Let elementType be TypedArrayElementType(typedArray).
  7. Perform SetValueInBuffer(buffer, byteIndexInBuffer, elementType, v, true, seq-cst).
  8. Return v.

25.4.12 Atomics.sub ( typedArray, index, value )

This function performs the following steps when called:

  1. Let subtract be a new read-modify-write modification function with parameters (xBytes, yBytes) that captures typedArray and performs the following steps atomically when called:
    1. Let type be TypedArrayElementType(typedArray).
    2. Let isLittleEndian be the value of the [[LittleEndian]] field of the surrounding agent's Agent Record.
    3. Let x be RawBytesToNumeric(type, xBytes, isLittleEndian).
    4. Let y be RawBytesToNumeric(type, yBytes, isLittleEndian).
    5. If x is a Number, then
      1. Let difference be Number::subtract(x, y).
    6. Else,
      1. Assert: x is a BigInt.
      2. Let difference be BigInt::subtract(x, y).
    7. Let differenceBytes be NumericToRawBytes(type, difference, isLittleEndian).
    8. Assert: differenceBytes, xBytes, and yBytes have the same number of elements.
    9. Return differenceBytes.
  2. Return ? AtomicReadModifyWrite(typedArray, index, value, subtract).

25.4.13 Atomics.wait ( typedArray, index, value, timeout )

This function puts the surrounding agent in a wait queue and suspends it until notified or until the wait times out, returning a String differentiating those cases.

It performs the following steps when called:

  1. Return ? DoWait(sync, typedArray, index, value, timeout).

25.4.14 Atomics.waitAsync ( typedArray, index, value, timeout )

This function returns a Promise that is resolved when the calling agent is notified or the timeout is reached.

It performs the following steps when called:

  1. Return ? DoWait(async, typedArray, index, value, timeout).

25.4.15 Atomics.notify ( typedArray, index, count )

This function notifies some agents that are sleeping in the wait queue.

It performs the following steps when called:

  1. Let taRecord be ? ValidateIntegerTypedArray(typedArray, true).
  2. Let byteIndexInBuffer be ? ValidateAtomicAccess(taRecord, index).
  3. If count is undefined, then
    1. Let c be +∞.
  4. Else,
    1. Let intCount be ? ToIntegerOrInfinity(count).
    2. Let c be max(intCount, 0).
  5. Let buffer be typedArray.[[ViewedArrayBuffer]].
  6. Let block be buffer.[[ArrayBufferData]].
  7. If IsSharedArrayBuffer(buffer) is false, return +0𝔽.
  8. Let WL be GetWaiterList(block, byteIndexInBuffer).
  9. Perform EnterCriticalSection(WL).
  10. Let S be RemoveWaiters(WL, c).
  11. For each element W of S, do
    1. Perform NotifyWaiter(WL, W).
  12. Perform LeaveCriticalSection(WL).
  13. Let n be the number of elements in S.
  14. Return 𝔽(n).

25.4.16 Atomics.xor ( typedArray, index, value )

This function performs the following steps when called:

  1. Let xor be a new read-modify-write modification function with parameters (xBytes, yBytes) that captures nothing and performs the following steps atomically when called:
    1. Return ByteListBitwiseOp(^, xBytes, yBytes).
  2. Return ? AtomicReadModifyWrite(typedArray, index, value, xor).

25.4.17 Atomics [ %Symbol.toStringTag% ]

The initial value of the %Symbol.toStringTag% property is the String value "Atomics".

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: true }.

25.5 The JSON Object

The JSON object:

  • is %JSON%.
  • is the initial value of the "JSON" property of the global object.
  • is an ordinary object.
  • contains two functions, parse and stringify, that are used to parse and construct JSON texts.
  • has a [[Prototype]] internal slot whose value is %Object.prototype%.
  • does not have a [[Construct]] internal method; it cannot be used as a constructor with the new operator.
  • does not have a [[Call]] internal method; it cannot be invoked as a function.

The JSON Data Interchange Format is defined in ECMA-404. The JSON interchange format used in this specification is exactly that described by ECMA-404. Conforming implementations of JSON.parse and JSON.stringify must support the exact interchange format described in the ECMA-404 specification without any deletions or extensions to the format.

25.5.1 JSON.parse ( text [ , reviver ] )

This function parses a JSON text (a JSON-formatted String) and produces an ECMAScript language value. The JSON format represents literals, arrays, and objects with a syntax similar to the syntax for ECMAScript literals, Array Initializers, and Object Initializers. After parsing, JSON objects are realized as ECMAScript objects. JSON arrays are realized as ECMAScript Array instances. JSON strings, numbers, booleans, and null are realized as ECMAScript Strings, Numbers, Booleans, and null.

The optional reviver parameter is a function that takes two parameters, key and value. It can filter and transform the results. It is called with each of the key/value pairs produced by the parse, and its return value is used instead of the original value. If it returns what it received, the structure is not modified. If it returns undefined then the property is deleted from the result.

  1. Let jsonString be ? ToString(text).
  2. Let unfiltered be ? ParseJSON(jsonString).
  3. If IsCallable(reviver) is true, then
    1. Let root be OrdinaryObjectCreate(%Object.prototype%).
    2. Let rootName be the empty String.
    3. Perform ! CreateDataPropertyOrThrow(root, rootName, unfiltered).
    4. Return ? InternalizeJSONProperty(root, rootName, reviver).
  4. Else,
    1. Return unfiltered.

The "length" property of this function is 2𝔽.

25.5.1.1 ParseJSON ( text )

The abstract operation ParseJSON takes argument text (a String) and returns either a normal completion containing an ECMAScript language value or a throw completion. It performs the following steps when called:

  1. If StringToCodePoints(text) is not a valid JSON text as specified in ECMA-404, throw a SyntaxError exception.
  2. Let scriptString be the string-concatenation of "(", text, and ");".
  3. Let script be ParseText(scriptString, Script).
  4. NOTE: The early error rules defined in 13.2.5.1 have special handling for the above invocation of ParseText.
  5. Assert: script is a Parse Node.
  6. Let result be ! Evaluation of script.
  7. NOTE: The PropertyDefinitionEvaluation semantics defined in 13.2.5.5 have special handling for the above evaluation.
  8. Assert: result is either a String, a Number, a Boolean, an Object that is defined by either an ArrayLiteral or an ObjectLiteral, or null.
  9. Return result.

It is not permitted for a conforming implementation of JSON.parse to extend the JSON grammars. If an implementation wishes to support a modified or extended JSON interchange format it must do so by defining a different parse function.

Note 1

Valid JSON text is a subset of the ECMAScript PrimaryExpression syntax. Step 1 verifies that jsonString conforms to that subset, and step 8 asserts that evaluation returns a value of an appropriate type.

However, because 13.2.5.5 behaves differently during ParseJSON, the same source text can produce different results when evaluated as a PrimaryExpression rather than as JSON. Furthermore, the Early Error for duplicate "__proto__" properties in object literals, which likewise does not apply during ParseJSON, means that not all texts accepted by ParseJSON are valid as a PrimaryExpression, despite matching the grammar.

Note 2

In the case where there are duplicate name Strings within an object, lexically preceding values for the same key shall be overwritten.

25.5.1.2 InternalizeJSONProperty ( holder, name, reviver )

The abstract operation InternalizeJSONProperty takes arguments holder (an Object), name (a String), and reviver (a function object) and returns either a normal completion containing an ECMAScript language value or a throw completion.

Note

This algorithm intentionally does not throw an exception if either [[Delete]] or CreateDataProperty return false.

It performs the following steps when called:

  1. Let val be ? Get(holder, name).
  2. If val is an Object, then
    1. Let isArray be ? IsArray(val).
    2. If isArray is true, then
      1. Let len be ? LengthOfArrayLike(val).
      2. Let I be 0.
      3. Repeat, while I < len,
        1. Let prop be ! ToString(𝔽(I)).
        2. Let newElement be ? InternalizeJSONProperty(val, prop, reviver).
        3. If newElement is undefined, then
          1. Perform ? val.[[Delete]](prop).
        4. Else,
          1. Perform ? CreateDataProperty(val, prop, newElement).
        5. Set I to I + 1.
    3. Else,
      1. Let keys be ? EnumerableOwnProperties(val, key).
      2. For each String P of keys, do
        1. Let newElement be ? InternalizeJSONProperty(val, P, reviver).
        2. If newElement is undefined, then
          1. Perform ? val.[[Delete]](P).
        3. Else,
          1. Perform ? CreateDataProperty(val, P, newElement).
  3. Return ? Call(reviver, holder, « name, val »).

25.5.2 JSON.stringify ( value [ , replacer [ , space ] ] )

This function returns a String in UTF-16 encoded JSON format representing an ECMAScript language value, or undefined. It can take three parameters. The value parameter is an ECMAScript language value, which is usually an object or array, although it can also be a String, Boolean, Number or null. The optional replacer parameter is either a function that alters the way objects and arrays are stringified, or an array of Strings and Numbers that acts as an inclusion list for selecting the object properties that will be stringified. The optional space parameter is a String or Number that allows the result to have white space injected into it to improve human readability.

It performs the following steps when called:

  1. Let stack be a new empty List.
  2. Let indent be the empty String.
  3. Let PropertyList be undefined.
  4. Let ReplacerFunction be undefined.
  5. If replacer is an Object, then
    1. If IsCallable(replacer) is true, then
      1. Set ReplacerFunction to replacer.
    2. Else,
      1. Let isArray be ? IsArray(replacer).
      2. If isArray is true, then
        1. Set PropertyList to a new empty List.
        2. Let len be ? LengthOfArrayLike(replacer).
        3. Let k be 0.
        4. Repeat, while k < len,
          1. Let prop be ! ToString(𝔽(k)).
          2. Let v be ? Get(replacer, prop).
          3. Let item be undefined.
          4. If v is a String, then
            1. Set item to v.
          5. Else if v is a Number, then
            1. Set item to ! ToString(v).
          6. Else if v is an Object, then
            1. If v has a [[StringData]] or [[NumberData]] internal slot, set item to ? ToString(v).
          7. If item is not undefined and PropertyList does not contain item, then
            1. Append item to PropertyList.
          8. Set k to k + 1.
  6. If space is an Object, then
    1. If space has a [[NumberData]] internal slot, then
      1. Set space to ? ToNumber(space).
    2. Else if space has a [[StringData]] internal slot, then
      1. Set space to ? ToString(space).
  7. If space is a Number, then
    1. Let spaceMV be ! ToIntegerOrInfinity(space).
    2. Set spaceMV to min(10, spaceMV).
    3. If spaceMV < 1, let gap be the empty String; otherwise let gap be the String value containing spaceMV occurrences of the code unit 0x0020 (SPACE).
  8. Else if space is a String, then
    1. If the length of space ≤ 10, let gap be space; otherwise let gap be the substring of space from 0 to 10.
  9. Else,
    1. Let gap be the empty String.
  10. Let wrapper be OrdinaryObjectCreate(%Object.prototype%).
  11. Perform ! CreateDataPropertyOrThrow(wrapper, the empty String, value).
  12. Let state be the JSON Serialization Record { [[ReplacerFunction]]: ReplacerFunction, [[Stack]]: stack, [[Indent]]: indent, [[Gap]]: gap, [[PropertyList]]: PropertyList }.
  13. Return ? SerializeJSONProperty(state, the empty String, wrapper).

The "length" property of this function is 3𝔽.

Note 1

JSON structures are allowed to be nested to any depth, but they must be acyclic. If value is or contains a cyclic structure, then this function must throw a TypeError exception. This is an example of a value that cannot be stringified:

a = [];
a[0] = a;
my_text = JSON.stringify(a); // This must throw a TypeError.
Note 2

Symbolic primitive values are rendered as follows:

  • The null value is rendered in JSON text as the String value "null".
  • The undefined value is not rendered.
  • The true value is rendered in JSON text as the String value "true".
  • The false value is rendered in JSON text as the String value "false".
Note 3

String values are wrapped in QUOTATION MARK (") code units. The code units " and \ are escaped with \ prefixes. Control characters code units are replaced with escape sequences \uHHHH, or with the shorter forms, \b (BACKSPACE), \f (FORM FEED), \n (LINE FEED), \r (CARRIAGE RETURN), \t (CHARACTER TABULATION).

Note 4

Finite numbers are stringified as if by calling ToString(number). NaN and Infinity regardless of sign are represented as the String value "null".

Note 5

Values that do not have a JSON representation (such as undefined and functions) do not produce a String. Instead they produce the undefined value. In arrays these values are represented as the String value "null". In objects an unrepresentable value causes the property to be excluded from stringification.

Note 6

An object is rendered as U+007B (LEFT CURLY BRACKET) followed by zero or more properties, separated with a U+002C (COMMA), closed with a U+007D (RIGHT CURLY BRACKET). A property is a quoted String representing the property name, a U+003A (COLON), and then the stringified property value. An array is rendered as an opening U+005B (LEFT SQUARE BRACKET) followed by zero or more values, separated with a U+002C (COMMA), closed with a U+005D (RIGHT SQUARE BRACKET).

25.5.2.1 JSON Serialization Record

A JSON Serialization Record is a Record value used to enable serialization to the JSON format.

JSON Serialization Records have the fields listed in Table 80.

Table 80: JSON Serialization Record Fields
Field Name Value Meaning
[[ReplacerFunction]] a function object or undefined A function that can supply replacement values for object properties (from JSON.stringify's replacer parameter).
[[PropertyList]] either a List of Strings or undefined The names of properties to include when serializing a non-array object (from JSON.stringify's replacer parameter).
[[Gap]] a String The unit of indentation (from JSON.stringify's space parameter).
[[Stack]] a List of Objects The set of nested objects that are in the process of being serialized. Used to detect cyclic structures.
[[Indent]] a String The current indentation.

25.5.2.2 SerializeJSONProperty ( state, key, holder )

The abstract operation SerializeJSONProperty takes arguments state (a JSON Serialization Record), key (a String), and holder (an Object) and returns either a normal completion containing either a String or undefined, or a throw completion. It performs the following steps when called:

  1. Let value be ? Get(holder, key).
  2. If value is an Object or value is a BigInt, then
    1. Let toJSON be ? GetV(value, "toJSON").
    2. If IsCallable(toJSON) is true, then
      1. Set value to ? Call(toJSON, value, « key »).
  3. If state.[[ReplacerFunction]] is not undefined, then
    1. Set value to ? Call(state.[[ReplacerFunction]], holder, « key, value »).
  4. If value is an Object, then
    1. If value has a [[NumberData]] internal slot, then
      1. Set value to ? ToNumber(value).
    2. Else if value has a [[StringData]] internal slot, then
      1. Set value to ? ToString(value).
    3. Else if value has a [[BooleanData]] internal slot, then
      1. Set value to value.[[BooleanData]].
    4. Else if value has a [[BigIntData]] internal slot, then
      1. Set value to value.[[BigIntData]].
  5. If value is null, return "null".
  6. If value is true, return "true".
  7. If value is false, return "false".
  8. If value is a String, return QuoteJSONString(value).
  9. If value is a Number, then
    1. If value is finite, return ! ToString(value).
    2. Return "null".
  10. If value is a BigInt, throw a TypeError exception.
  11. If value is an Object and IsCallable(value) is false, then
    1. Let isArray be ? IsArray(value).
    2. If isArray is true, return ? SerializeJSONArray(state, value).
    3. Return ? SerializeJSONObject(state, value).
  12. Return undefined.

25.5.2.3 QuoteJSONString ( value )

The abstract operation QuoteJSONString takes argument value (a String) and returns a String. It wraps value in 0x0022 (QUOTATION MARK) code units and escapes certain other code units within it. This operation interprets value as a sequence of UTF-16 encoded code points, as described in 6.1.4. It performs the following steps when called:

  1. Let product be the String value consisting solely of the code unit 0x0022 (QUOTATION MARK).
  2. For each code point C of StringToCodePoints(value), do
    1. If C is listed in the “Code Point” column of Table 81, then
      1. Set product to the string-concatenation of product and the escape sequence for C as specified in the “Escape Sequence” column of the corresponding row.
    2. Else if C has a numeric value less than 0x0020 (SPACE) or C has the same numeric value as a leading surrogate or trailing surrogate, then
      1. Let unit be the code unit whose numeric value is the numeric value of C.
      2. Set product to the string-concatenation of product and UnicodeEscape(unit).
    3. Else,
      1. Set product to the string-concatenation of product and UTF16EncodeCodePoint(C).
  3. Set product to the string-concatenation of product and the code unit 0x0022 (QUOTATION MARK).
  4. Return product.
Table 81: JSON Single Character Escape Sequences
Code Point Unicode Character Name Escape Sequence
U+0008 BACKSPACE \b
U+0009 CHARACTER TABULATION \t
U+000A LINE FEED (LF) \n
U+000C FORM FEED (FF) \f
U+000D CARRIAGE RETURN (CR) \r
U+0022 QUOTATION MARK \"
U+005C REVERSE SOLIDUS \\

25.5.2.4 UnicodeEscape ( C )

The abstract operation UnicodeEscape takes argument C (a code unit) and returns a String. It represents C as a Unicode escape sequence. It performs the following steps when called:

  1. Let n be the numeric value of C.
  2. Assert: n ≤ 0xFFFF.
  3. Let hex be the String representation of n, formatted as a lowercase hexadecimal number.
  4. Return the string-concatenation of the code unit 0x005C (REVERSE SOLIDUS), "u", and StringPad(hex, 4, "0", start).

25.5.2.5 SerializeJSONObject ( state, value )

The abstract operation SerializeJSONObject takes arguments state (a JSON Serialization Record) and value (an Object) and returns either a normal completion containing a String or a throw completion. It serializes an object. It performs the following steps when called:

  1. If state.[[Stack]] contains value, throw a TypeError exception because the structure is cyclical.
  2. Append value to state.[[Stack]].
  3. Let stepBack be state.[[Indent]].
  4. Set state.[[Indent]] to the string-concatenation of state.[[Indent]] and state.[[Gap]].
  5. If state.[[PropertyList]] is not undefined, then
    1. Let K be state.[[PropertyList]].
  6. Else,
    1. Let K be ? EnumerableOwnProperties(value, key).
  7. Let partial be a new empty List.
  8. For each element P of K, do
    1. Let strP be ? SerializeJSONProperty(state, P, value).
    2. If strP is not undefined, then
      1. Let member be QuoteJSONString(P).
      2. Set member to the string-concatenation of member and ":".
      3. If state.[[Gap]] is not the empty String, then
        1. Set member to the string-concatenation of member and the code unit 0x0020 (SPACE).
      4. Set member to the string-concatenation of member and strP.
      5. Append member to partial.
  9. If partial is empty, then
    1. Let final be "{}".
  10. Else,
    1. If state.[[Gap]] is the empty String, then
      1. Let properties be the String value formed by concatenating all the element Strings of partial with each adjacent pair of Strings separated with the code unit 0x002C (COMMA). A comma is not inserted either before the first String or after the last String.
      2. Let final be the string-concatenation of "{", properties, and "}".
    2. Else,
      1. Let separator be the string-concatenation of the code unit 0x002C (COMMA), the code unit 0x000A (LINE FEED), and state.[[Indent]].
      2. Let properties be the String value formed by concatenating all the element Strings of partial with each adjacent pair of Strings separated with separator. The separator String is not inserted either before the first String or after the last String.
      3. Let final be the string-concatenation of "{", the code unit 0x000A (LINE FEED), state.[[Indent]], properties, the code unit 0x000A (LINE FEED), stepBack, and "}".
  11. Remove the last element of state.[[Stack]].
  12. Set state.[[Indent]] to stepBack.
  13. Return final.

25.5.2.6 SerializeJSONArray ( state, value )

The abstract operation SerializeJSONArray takes arguments state (a JSON Serialization Record) and value (an ECMAScript language value) and returns either a normal completion containing a String or a throw completion. It serializes an array. It performs the following steps when called:

  1. If state.[[Stack]] contains value, throw a TypeError exception because the structure is cyclical.
  2. Append value to state.[[Stack]].
  3. Let stepBack be state.[[Indent]].
  4. Set state.[[Indent]] to the string-concatenation of state.[[Indent]] and state.[[Gap]].
  5. Let partial be a new empty List.
  6. Let len be ? LengthOfArrayLike(value).
  7. Let index be 0.
  8. Repeat, while index < len,
    1. Let strP be ? SerializeJSONProperty(state, ! ToString(𝔽(index)), value).
    2. If strP is undefined, then
      1. Append "null" to partial.
    3. Else,
      1. Append strP to partial.
    4. Set index to index + 1.
  9. If partial is empty, then
    1. Let final be "[]".
  10. Else,
    1. If state.[[Gap]] is the empty String, then
      1. Let properties be the String value formed by concatenating all the element Strings of partial with each adjacent pair of Strings separated with the code unit 0x002C (COMMA). A comma is not inserted either before the first String or after the last String.
      2. Let final be the string-concatenation of "[", properties, and "]".
    2. Else,
      1. Let separator be the string-concatenation of the code unit 0x002C (COMMA), the code unit 0x000A (LINE FEED), and state.[[Indent]].
      2. Let properties be the String value formed by concatenating all the element Strings of partial with each adjacent pair of Strings separated with separator. The separator String is not inserted either before the first String or after the last String.
      3. Let final be the string-concatenation of "[", the code unit 0x000A (LINE FEED), state.[[Indent]], properties, the code unit 0x000A (LINE FEED), stepBack, and "]".
  11. Remove the last element of state.[[Stack]].
  12. Set state.[[Indent]] to stepBack.
  13. Return final.
Note

The representation of arrays includes only the elements in the interval from +0𝔽 (inclusive) to array.length (exclusive). Properties whose keys are not array indices are excluded from the stringification. An array is stringified as an opening LEFT SQUARE BRACKET, elements separated by COMMA, and a closing RIGHT SQUARE BRACKET.

25.5.3 JSON [ %Symbol.toStringTag% ]

The initial value of the %Symbol.toStringTag% property is the String value "JSON".

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: true }.

26 Managing Memory

26.1 WeakRef Objects

A WeakRef is an object that is used to refer to a target object or symbol without preserving it from garbage collection. WeakRefs can be dereferenced to allow access to the target value, if the target hasn't been reclaimed by garbage collection.

26.1.1 The WeakRef Constructor

The WeakRef constructor:

  • is %WeakRef%.
  • is the initial value of the "WeakRef" property of the global object.
  • creates and initializes a new WeakRef when called as a constructor.
  • is not intended to be called as a function and will throw an exception when called in that manner.
  • may be used as the value in an extends clause of a class definition. Subclass constructors that intend to inherit the specified WeakRef behaviour must include a super call to the WeakRef constructor to create and initialize the subclass instance with the internal state necessary to support the WeakRef.prototype built-in methods.

26.1.1.1 WeakRef ( target )

This function performs the following steps when called:

  1. If NewTarget is undefined, throw a TypeError exception.
  2. If CanBeHeldWeakly(target) is false, throw a TypeError exception.
  3. Let weakRef be ? OrdinaryCreateFromConstructor(NewTarget, "%WeakRef.prototype%", « [[WeakRefTarget]] »).
  4. Perform AddToKeptObjects(target).
  5. Set weakRef.[[WeakRefTarget]] to target.
  6. Return weakRef.

26.1.2 Properties of the WeakRef Constructor

The WeakRef constructor:

  • has a [[Prototype]] internal slot whose value is %Function.prototype%.
  • has the following properties:

26.1.2.1 WeakRef.prototype

The initial value of WeakRef.prototype is the WeakRef prototype object.

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: false }.

26.1.3 Properties of the WeakRef Prototype Object

The WeakRef prototype object:

  • is %WeakRef.prototype%.
  • has a [[Prototype]] internal slot whose value is %Object.prototype%.
  • is an ordinary object.
  • does not have a [[WeakRefTarget]] internal slot.

26.1.3.1 WeakRef.prototype.constructor

The initial value of WeakRef.prototype.constructor is %WeakRef%.

26.1.3.2 WeakRef.prototype.deref ( )

This method performs the following steps when called:

  1. Let weakRef be the this value.
  2. Perform ? RequireInternalSlot(weakRef, [[WeakRefTarget]]).
  3. Return WeakRefDeref(weakRef).
Note

If the WeakRef returns a target value that is not undefined, then this target value should not be garbage collected until the current execution of ECMAScript code has completed. The AddToKeptObjects operation makes sure read consistency is maintained.

let target = { foo() {} };
let weakRef = new WeakRef(target);

// ... later ...

if (weakRef.deref()) {
  weakRef.deref().foo();
}

In the above example, if the first deref does not evaluate to undefined then the second deref cannot either.

26.1.3.3 WeakRef.prototype [ %Symbol.toStringTag% ]

The initial value of the %Symbol.toStringTag% property is the String value "WeakRef".

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: true }.

26.1.4 WeakRef Abstract Operations

26.1.4.1 WeakRefDeref ( weakRef )

The abstract operation WeakRefDeref takes argument weakRef (a WeakRef) and returns an ECMAScript language value. It performs the following steps when called:

  1. Let target be weakRef.[[WeakRefTarget]].
  2. If target is not empty, then
    1. Perform AddToKeptObjects(target).
    2. Return target.
  3. Return undefined.
Note

This abstract operation is defined separately from WeakRef.prototype.deref strictly to make it possible to succinctly define liveness.

26.1.5 Properties of WeakRef Instances

WeakRef instances are ordinary objects that inherit properties from the WeakRef prototype object. WeakRef instances also have a [[WeakRefTarget]] internal slot.

26.2 FinalizationRegistry Objects

A FinalizationRegistry is an object that manages registration and unregistration of cleanup operations that are performed when target objects and symbols are garbage collected.

26.2.1 The FinalizationRegistry Constructor

The FinalizationRegistry constructor:

  • is %FinalizationRegistry%.
  • is the initial value of the "FinalizationRegistry" property of the global object.
  • creates and initializes a new FinalizationRegistry when called as a constructor.
  • is not intended to be called as a function and will throw an exception when called in that manner.
  • may be used as the value in an extends clause of a class definition. Subclass constructors that intend to inherit the specified FinalizationRegistry behaviour must include a super call to the FinalizationRegistry constructor to create and initialize the subclass instance with the internal state necessary to support the FinalizationRegistry.prototype built-in methods.

26.2.1.1 FinalizationRegistry ( cleanupCallback )

This function performs the following steps when called:

  1. If NewTarget is undefined, throw a TypeError exception.
  2. If IsCallable(cleanupCallback) is false, throw a TypeError exception.
  3. Let finalizationRegistry be ? OrdinaryCreateFromConstructor(NewTarget, "%FinalizationRegistry.prototype%", « [[Realm]], [[CleanupCallback]], [[Cells]] »).
  4. Let fn be the active function object.
  5. Set finalizationRegistry.[[Realm]] to fn.[[Realm]].
  6. Set finalizationRegistry.[[CleanupCallback]] to HostMakeJobCallback(cleanupCallback).
  7. Set finalizationRegistry.[[Cells]] to a new empty List.
  8. Return finalizationRegistry.

26.2.2 Properties of the FinalizationRegistry Constructor

The FinalizationRegistry constructor:

  • has a [[Prototype]] internal slot whose value is %Function.prototype%.
  • has the following properties:

26.2.2.1 FinalizationRegistry.prototype

The initial value of FinalizationRegistry.prototype is the FinalizationRegistry prototype object.

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: false }.

26.2.3 Properties of the FinalizationRegistry Prototype Object

The FinalizationRegistry prototype object:

  • is %FinalizationRegistry.prototype%.
  • has a [[Prototype]] internal slot whose value is %Object.prototype%.
  • is an ordinary object.
  • does not have [[Cells]] and [[CleanupCallback]] internal slots.

26.2.3.1 FinalizationRegistry.prototype.constructor

The initial value of FinalizationRegistry.prototype.constructor is %FinalizationRegistry%.

26.2.3.2 FinalizationRegistry.prototype.register ( target, heldValue [ , unregisterToken ] )

This method performs the following steps when called:

  1. Let finalizationRegistry be the this value.
  2. Perform ? RequireInternalSlot(finalizationRegistry, [[Cells]]).
  3. If CanBeHeldWeakly(target) is false, throw a TypeError exception.
  4. If SameValue(target, heldValue) is true, throw a TypeError exception.
  5. If CanBeHeldWeakly(unregisterToken) is false, then
    1. If unregisterToken is not undefined, throw a TypeError exception.
    2. Set unregisterToken to empty.
  6. Let cell be the Record { [[WeakRefTarget]]: target, [[HeldValue]]: heldValue, [[UnregisterToken]]: unregisterToken }.
  7. Append cell to finalizationRegistry.[[Cells]].
  8. Return undefined.
Note

Based on the algorithms and definitions in this specification, cell.[[HeldValue]] is live when finalizationRegistry.[[Cells]] contains cell; however, this does not necessarily mean that cell.[[UnregisterToken]] or cell.[[Target]] are live. For example, registering an object with itself as its unregister token would not keep the object alive forever.

26.2.3.3 FinalizationRegistry.prototype.unregister ( unregisterToken )

This method performs the following steps when called:

  1. Let finalizationRegistry be the this value.
  2. Perform ? RequireInternalSlot(finalizationRegistry, [[Cells]]).
  3. If CanBeHeldWeakly(unregisterToken) is false, throw a TypeError exception.
  4. Let removed be false.
  5. For each Record { [[WeakRefTarget]], [[HeldValue]], [[UnregisterToken]] } cell of finalizationRegistry.[[Cells]], do
    1. If cell.[[UnregisterToken]] is not empty and SameValue(cell.[[UnregisterToken]], unregisterToken) is true, then
      1. Remove cell from finalizationRegistry.[[Cells]].
      2. Set removed to true.
  6. Return removed.

26.2.3.4 FinalizationRegistry.prototype [ %Symbol.toStringTag% ]

The initial value of the %Symbol.toStringTag% property is the String value "FinalizationRegistry".

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: true }.

26.2.4 Properties of FinalizationRegistry Instances

FinalizationRegistry instances are ordinary objects that inherit properties from the FinalizationRegistry prototype object. FinalizationRegistry instances also have [[Cells]] and [[CleanupCallback]] internal slots.

27 Control Abstraction Objects

27.1 Iteration

27.1.1 Common Iteration Interfaces

An interface is a set of property keys whose associated values match a specific specification. Any object that provides all the properties as described by an interface's specification conforms to that interface. An interface is not represented by a distinct object. There may be many separately implemented objects that conform to any interface. An individual object may conform to multiple interfaces.

27.1.1.1 The Iterable Interface

The iterable interface includes the property described in Table 82:

Table 82: Iterable Interface Required Properties
Property Value Requirements
%Symbol.iterator% a function that returns an iterator object The returned object must conform to the iterator interface.

27.1.1.2 The Iterator Interface

An object that implements the iterator interface must include the property in Table 83. Such objects may also implement the properties in Table 84.

Table 83: Iterator Interface Required Properties
Property Value Requirements
"next" a function that returns an IteratorResult object The returned object must conform to the IteratorResult interface. If a previous call to the next method of an iterator has returned an IteratorResult object whose "done" property is true, then all subsequent calls to the next method of that object should also return an IteratorResult object whose "done" property is true. However, this requirement is not enforced.
Note 1

Arguments may be passed to the next function but their interpretation and validity is dependent upon the target iterator. The for-of statement and other common users of iterators do not pass any arguments, so iterator objects that expect to be used in such a manner must be prepared to deal with being called with no arguments.

Table 84: Iterator Interface Optional Properties
Property Value Requirements
"return" a function that returns an IteratorResult object The returned object must conform to the IteratorResult interface. Invoking this method notifies the iterator object that the caller does not intend to make any more next method calls to the iterator. The returned IteratorResult object will typically have a "done" property whose value is true, and a "value" property with the value passed as the argument of the return method. However, this requirement is not enforced.
"throw" a function that returns an IteratorResult object The returned object must conform to the IteratorResult interface. Invoking this method notifies the iterator object that the caller has detected an error condition. The argument may be used to identify the error condition and typically will be an exception object. A typical response is to throw the value passed as the argument. If the method does not throw, the returned IteratorResult object will typically have a "done" property whose value is true.
Note 2

Typically callers of these methods should check for their existence before invoking them. Certain ECMAScript language features including for-of, yield*, and array destructuring call these methods after performing an existence check. Most ECMAScript library functions that accept iterable objects as arguments also conditionally call them.

27.1.1.3 The Async Iterable Interface

The async iterable interface includes the properties described in Table 85:

Table 85: Async Iterable Interface Required Properties
Property Value Requirements
%Symbol.asyncIterator% a function that returns an async iterator object The returned object must conform to the async iterator interface.

27.1.1.4 The Async Iterator Interface

An object that implements the async iterator interface must include the properties in Table 86. Such objects may also implement the properties in Table 87.

Table 86: Async Iterator Interface Required Properties
Property Value Requirements
"next" a function that returns a promise for an IteratorResult object

The returned promise, when fulfilled, must fulfill with an object that conforms to the IteratorResult interface. If a previous call to the next method of an async iterator has returned a promise for an IteratorResult object whose "done" property is true, then all subsequent calls to the next method of that object should also return a promise for an IteratorResult object whose "done" property is true. However, this requirement is not enforced.

Additionally, the IteratorResult object that serves as a fulfillment value should have a "value" property whose value is not a promise (or "thenable"). However, this requirement is also not enforced.

Note 1

Arguments may be passed to the next function but their interpretation and validity is dependent upon the target async iterator. The for-await-of statement and other common users of async iterators do not pass any arguments, so async iterator objects that expect to be used in such a manner must be prepared to deal with being called with no arguments.

Table 87: Async Iterator Interface Optional Properties
Property Value Requirements
"return" a function that returns a promise for an IteratorResult object

The returned promise, when fulfilled, must fulfill with an object that conforms to the IteratorResult interface. Invoking this method notifies the async iterator object that the caller does not intend to make any more next method calls to the async iterator. The returned promise will fulfill with an IteratorResult object which will typically have a "done" property whose value is true, and a "value" property with the value passed as the argument of the return method. However, this requirement is not enforced.

Additionally, the IteratorResult object that serves as a fulfillment value should have a "value" property whose value is not a promise (or "thenable"). If the argument value is used in the typical manner, then if it is a rejected promise, a promise rejected with the same reason should be returned; if it is a fulfilled promise, then its fulfillment value should be used as the "value" property of the returned promise's IteratorResult object fulfillment value. However, these requirements are also not enforced.

"throw" a function that returns a promise for an IteratorResult object

The returned promise, when fulfilled, must fulfill with an object that conforms to the IteratorResult interface. Invoking this method notifies the async iterator object that the caller has detected an error condition. The argument may be used to identify the error condition and typically will be an exception object. A typical response is to return a rejected promise which rejects with the value passed as the argument.

If the returned promise is fulfilled, the IteratorResult object fulfillment value will typically have a "done" property whose value is true. Additionally, it should have a "value" property whose value is not a promise (or "thenable"), but this requirement is not enforced.

Note 2

Typically callers of these methods should check for their existence before invoking them. Certain ECMAScript language features including for-await-of and yield* call these methods after performing an existence check.

27.1.1.5 The IteratorResult Interface

The IteratorResult interface includes the properties listed in Table 88:

Table 88: IteratorResult Interface Properties
Property Value Requirements
"done" a Boolean This is the result status of an iterator next method call. If the end of the iterator was reached "done" is true. If the end was not reached "done" is false and a value is available. If a "done" property (either own or inherited) does not exist, it is considered to have the value false.
"value" an ECMAScript language value If done is false, this is the current iteration element value. If done is true, this is the return value of the iterator, if it supplied one. If the iterator does not have a return value, "value" is undefined. In that case, the "value" property may be absent from the conforming object if it does not inherit an explicit "value" property.

27.1.2 Iterator Helper Objects

An Iterator Helper object is an ordinary object that represents a lazy transformation of some specific source iterator object. There is not a named constructor for Iterator Helper objects. Instead, Iterator Helper objects are created by calling certain methods of Iterator instance objects.

27.1.2.1 The %IteratorHelperPrototype% Object

The %IteratorHelperPrototype% object:

27.1.2.1.1 %IteratorHelperPrototype%.next ( )

  1. Return ? GeneratorResume(this value, undefined, "Iterator Helper").

27.1.2.1.2 %IteratorHelperPrototype%.return ( )

  1. Let O be this value.
  2. Perform ? RequireInternalSlot(O, [[UnderlyingIterator]]).
  3. Assert: O has a [[GeneratorState]] internal slot.
  4. If O.[[GeneratorState]] is suspended-start, then
    1. Set O.[[GeneratorState]] to completed.
    2. NOTE: Once a generator enters the completed state it never leaves it and its associated execution context is never resumed. Any execution state associated with O can be discarded at this point.
    3. Perform ? IteratorClose(O.[[UnderlyingIterator]], NormalCompletion(unused)).
    4. Return CreateIteratorResultObject(undefined, true).
  5. Let C be ReturnCompletion(undefined).
  6. Return ? GeneratorResumeAbrupt(O, C, "Iterator Helper").

27.1.2.1.3 %IteratorHelperPrototype% [ %Symbol.toStringTag% ]

The initial value of the %Symbol.toStringTag% property is the String value "Iterator Helper".

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: true }.

27.1.3 Iterator Objects

27.1.3.1 The Iterator Constructor

The Iterator constructor:

  • is %Iterator%.
  • is the initial value of the "Iterator" property of the global object.
  • is designed to be subclassable. It may be used as the value of an extends clause of a class definition.

27.1.3.1.1 Iterator ( )

This function performs the following steps when called:

  1. If NewTarget is either undefined or the active function object, throw a TypeError exception.
  2. Return ? OrdinaryCreateFromConstructor(NewTarget, "%Iterator.prototype%").

27.1.3.2 Properties of the Iterator Constructor

The Iterator constructor:

  • has a [[Prototype]] internal slot whose value is %Function.prototype%.
  • has the following properties:

27.1.3.2.1 Iterator.from ( O )

  1. Let iteratorRecord be ? GetIteratorFlattenable(O, iterate-string-primitives).
  2. Let hasInstance be ? OrdinaryHasInstance(%Iterator%, iteratorRecord.[[Iterator]]).
  3. If hasInstance is true, then
    1. Return iteratorRecord.[[Iterator]].
  4. Let wrapper be OrdinaryObjectCreate(%WrapForValidIteratorPrototype%, « [[Iterated]] »).
  5. Set wrapper.[[Iterated]] to iteratorRecord.
  6. Return wrapper.

27.1.3.2.1.1 The %WrapForValidIteratorPrototype% Object

The %WrapForValidIteratorPrototype% object:

27.1.3.2.1.1.1 %WrapForValidIteratorPrototype%.next ( )

  1. Let O be this value.
  2. Perform ? RequireInternalSlot(O, [[Iterated]]).
  3. Let iteratorRecord be O.[[Iterated]].
  4. Return ? Call(iteratorRecord.[[NextMethod]], iteratorRecord.[[Iterator]]).

27.1.3.2.1.1.2 %WrapForValidIteratorPrototype%.return ( )

  1. Let O be this value.
  2. Perform ? RequireInternalSlot(O, [[Iterated]]).
  3. Let iterator be O.[[Iterated]].[[Iterator]].
  4. Assert: iterator is an Object.
  5. Let returnMethod be ? GetMethod(iterator, "return").
  6. If returnMethod is undefined, then
    1. Return CreateIteratorResultObject(undefined, true).
  7. Return ? Call(returnMethod, iterator).

27.1.3.2.2 Iterator.prototype

The initial value of Iterator.prototype is the Iterator prototype object.

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: false }.

27.1.4 Properties of the Iterator Prototype Object

The Iterator prototype object:

Note

All objects defined in this specification that implement the iterator interface also inherit from %Iterator.prototype%. ECMAScript code may also define objects that inherit from %Iterator.prototype%. %Iterator.prototype% provides a place where additional methods that are applicable to all iterator objects may be added.

The following expression is one way that ECMAScript code can access the %Iterator.prototype% object:

Object.getPrototypeOf(Object.getPrototypeOf([][Symbol.iterator]()))

27.1.4.1 Iterator.prototype.constructor

Iterator.prototype.constructor is an accessor property with attributes { [[Enumerable]]: false, [[Configurable]]: true }. The [[Get]] and [[Set]] attributes are defined as follows:

27.1.4.1.1 get Iterator.prototype.constructor

The value of the [[Get]] attribute is a built-in function that requires no arguments. It performs the following steps when called:

  1. Return %Iterator%.

27.1.4.1.2 set Iterator.prototype.constructor

The value of the [[Set]] attribute is a built-in function that takes an argument v. It performs the following steps when called:

  1. Perform ? SetterThatIgnoresPrototypeProperties(this value, %Iterator.prototype%, "constructor", v).
  2. Return undefined.
Note

Unlike the "constructor" property on most built-in prototypes, for web-compatibility reasons this property must be an accessor.

27.1.4.2 Iterator.prototype.drop ( limit )

This method performs the following steps when called:

  1. Let O be the this value.
  2. If O is not an Object, throw a TypeError exception.
  3. Let iterated be the Iterator Record { [[Iterator]]: O, [[NextMethod]]: undefined, [[Done]]: false }.
  4. Let numLimit be Completion(ToNumber(limit)).
  5. IfAbruptCloseIterator(numLimit, iterated).
  6. If numLimit is NaN, then
    1. Let error be ThrowCompletion(a newly created RangeError object).
    2. Return ? IteratorClose(iterated, error).
  7. Let integerLimit be ! ToIntegerOrInfinity(numLimit).
  8. If integerLimit < 0, then
    1. Let error be ThrowCompletion(a newly created RangeError object).
    2. Return ? IteratorClose(iterated, error).
  9. Set iterated to ? GetIteratorDirect(O).
  10. Let closure be a new Abstract Closure with no parameters that captures iterated and integerLimit and performs the following steps when called:
    1. Let remaining be integerLimit.
    2. Repeat, while remaining > 0,
      1. If remaining ≠ +∞, then
        1. Set remaining to remaining - 1.
      2. Let next be ? IteratorStep(iterated).
      3. If next is done, return ReturnCompletion(undefined).
    3. Repeat,
      1. Let value be ? IteratorStepValue(iterated).
      2. If value is done, return ReturnCompletion(undefined).
      3. Let completion be Completion(Yield(value)).
      4. IfAbruptCloseIterator(completion, iterated).
  11. Let result be CreateIteratorFromClosure(closure, "Iterator Helper", %IteratorHelperPrototype%, « [[UnderlyingIterator]] »).
  12. Set result.[[UnderlyingIterator]] to iterated.
  13. Return result.

27.1.4.3 Iterator.prototype.every ( predicate )

This method performs the following steps when called:

  1. Let O be the this value.
  2. If O is not an Object, throw a TypeError exception.
  3. Let iterated be the Iterator Record { [[Iterator]]: O, [[NextMethod]]: undefined, [[Done]]: false }.
  4. If IsCallable(predicate) is false, then
    1. Let error be ThrowCompletion(a newly created TypeError object).
    2. Return ? IteratorClose(iterated, error).
  5. Set iterated to ? GetIteratorDirect(O).
  6. Let counter be 0.
  7. Repeat,
    1. Let value be ? IteratorStepValue(iterated).
    2. If value is done, return true.
    3. Let result be Completion(Call(predicate, undefined, « value, 𝔽(counter) »)).
    4. IfAbruptCloseIterator(result, iterated).
    5. If ToBoolean(result) is false, return ? IteratorClose(iterated, NormalCompletion(false)).
    6. Set counter to counter + 1.

27.1.4.4 Iterator.prototype.filter ( predicate )

This method performs the following steps when called:

  1. Let O be the this value.
  2. If O is not an Object, throw a TypeError exception.
  3. Let iterated be the Iterator Record { [[Iterator]]: O, [[NextMethod]]: undefined, [[Done]]: false }.
  4. If IsCallable(predicate) is false, then
    1. Let error be ThrowCompletion(a newly created TypeError object).
    2. Return ? IteratorClose(iterated, error).
  5. Set iterated to ? GetIteratorDirect(O).
  6. Let closure be a new Abstract Closure with no parameters that captures iterated and predicate and performs the following steps when called:
    1. Let counter be 0.
    2. Repeat,
      1. Let value be ? IteratorStepValue(iterated).
      2. If value is done, return ReturnCompletion(undefined).
      3. Let selected be Completion(Call(predicate, undefined, « value, 𝔽(counter) »)).
      4. IfAbruptCloseIterator(selected, iterated).
      5. If ToBoolean(selected) is true, then
        1. Let completion be Completion(Yield(value)).
        2. IfAbruptCloseIterator(completion, iterated).
      6. Set counter to counter + 1.
  7. Let result be CreateIteratorFromClosure(closure, "Iterator Helper", %IteratorHelperPrototype%, « [[UnderlyingIterator]] »).
  8. Set result.[[UnderlyingIterator]] to iterated.
  9. Return result.

27.1.4.5 Iterator.prototype.find ( predicate )

This method performs the following steps when called:

  1. Let O be the this value.
  2. If O is not an Object, throw a TypeError exception.
  3. Let iterated be the Iterator Record { [[Iterator]]: O, [[NextMethod]]: undefined, [[Done]]: false }.
  4. If IsCallable(predicate) is false, then
    1. Let error be ThrowCompletion(a newly created TypeError object).
    2. Return ? IteratorClose(iterated, error).
  5. Set iterated to ? GetIteratorDirect(O).
  6. Let counter be 0.
  7. Repeat,
    1. Let value be ? IteratorStepValue(iterated).
    2. If value is done, return undefined.
    3. Let result be Completion(Call(predicate, undefined, « value, 𝔽(counter) »)).
    4. IfAbruptCloseIterator(result, iterated).
    5. If ToBoolean(result) is true, return ? IteratorClose(iterated, NormalCompletion(value)).
    6. Set counter to counter + 1.

27.1.4.6 Iterator.prototype.flatMap ( mapper )

This method performs the following steps when called:

  1. Let O be the this value.
  2. If O is not an Object, throw a TypeError exception.
  3. Let iterated be the Iterator Record { [[Iterator]]: O, [[NextMethod]]: undefined, [[Done]]: false }.
  4. If IsCallable(mapper) is false, then
    1. Let error be ThrowCompletion(a newly created TypeError object).
    2. Return ? IteratorClose(iterated, error).
  5. Set iterated to ? GetIteratorDirect(O).
  6. Let closure be a new Abstract Closure with no parameters that captures iterated and mapper and performs the following steps when called:
    1. Let counter be 0.
    2. Repeat,
      1. Let value be ? IteratorStepValue(iterated).
      2. If value is done, return ReturnCompletion(undefined).
      3. Let mapped be Completion(Call(mapper, undefined, « value, 𝔽(counter) »)).
      4. IfAbruptCloseIterator(mapped, iterated).
      5. Let innerIterator be Completion(GetIteratorFlattenable(mapped, reject-primitives)).
      6. IfAbruptCloseIterator(innerIterator, iterated).
      7. Let innerAlive be true.
      8. Repeat, while innerAlive is true,
        1. Let innerValue be Completion(IteratorStepValue(innerIterator)).
        2. IfAbruptCloseIterator(innerValue, iterated).
        3. If innerValue is done, then
          1. Set innerAlive to false.
        4. Else,
          1. Let completion be Completion(Yield(innerValue)).
          2. If completion is an abrupt completion, then
            1. Let backupCompletion be Completion(IteratorClose(innerIterator, completion)).
            2. IfAbruptCloseIterator(backupCompletion, iterated).
            3. Return ? IteratorClose(iterated, completion).
      9. Set counter to counter + 1.
  7. Let result be CreateIteratorFromClosure(closure, "Iterator Helper", %IteratorHelperPrototype%, « [[UnderlyingIterator]] »).
  8. Set result.[[UnderlyingIterator]] to iterated.
  9. Return result.

27.1.4.7 Iterator.prototype.forEach ( procedure )

This method performs the following steps when called:

  1. Let O be the this value.
  2. If O is not an Object, throw a TypeError exception.
  3. Let iterated be the Iterator Record { [[Iterator]]: O, [[NextMethod]]: undefined, [[Done]]: false }.
  4. If IsCallable(procedure) is false, then
    1. Let error be ThrowCompletion(a newly created TypeError object).
    2. Return ? IteratorClose(iterated, error).
  5. Set iterated to ? GetIteratorDirect(O).
  6. Let counter be 0.
  7. Repeat,
    1. Let value be ? IteratorStepValue(iterated).
    2. If value is done, return undefined.
    3. Let result be Completion(Call(procedure, undefined, « value, 𝔽(counter) »)).
    4. IfAbruptCloseIterator(result, iterated).
    5. Set counter to counter + 1.

27.1.4.8 Iterator.prototype.map ( mapper )

This method performs the following steps when called:

  1. Let O be the this value.
  2. If O is not an Object, throw a TypeError exception.
  3. Let iterated be the Iterator Record { [[Iterator]]: O, [[NextMethod]]: undefined, [[Done]]: false }.
  4. If IsCallable(mapper) is false, then
    1. Let error be ThrowCompletion(a newly created TypeError object).
    2. Return ? IteratorClose(iterated, error).
  5. Set iterated to ? GetIteratorDirect(O).
  6. Let closure be a new Abstract Closure with no parameters that captures iterated and mapper and performs the following steps when called:
    1. Let counter be 0.
    2. Repeat,
      1. Let value be ? IteratorStepValue(iterated).
      2. If value is done, return ReturnCompletion(undefined).
      3. Let mapped be Completion(Call(mapper, undefined, « value, 𝔽(counter) »)).
      4. IfAbruptCloseIterator(mapped, iterated).
      5. Let completion be Completion(Yield(mapped)).
      6. IfAbruptCloseIterator(completion, iterated).
      7. Set counter to counter + 1.
  7. Let result be CreateIteratorFromClosure(closure, "Iterator Helper", %IteratorHelperPrototype%, « [[UnderlyingIterator]] »).
  8. Set result.[[UnderlyingIterator]] to iterated.
  9. Return result.

27.1.4.9 Iterator.prototype.reduce ( reducer [ , initialValue ] )

This method performs the following steps when called:

  1. Let O be the this value.
  2. If O is not an Object, throw a TypeError exception.
  3. Let iterated be the Iterator Record { [[Iterator]]: O, [[NextMethod]]: undefined, [[Done]]: false }.
  4. If IsCallable(reducer) is false, then
    1. Let error be ThrowCompletion(a newly created TypeError object).
    2. Return ? IteratorClose(iterated, error).
  5. Set iterated to ? GetIteratorDirect(O).
  6. If initialValue is not present, then
    1. Let accumulator be ? IteratorStepValue(iterated).
    2. If accumulator is done, throw a TypeError exception.
    3. Let counter be 1.
  7. Else,
    1. Let accumulator be initialValue.
    2. Let counter be 0.
  8. Repeat,
    1. Let value be ? IteratorStepValue(iterated).
    2. If value is done, return accumulator.
    3. Let result be Completion(Call(reducer, undefined, « accumulator, value, 𝔽(counter) »)).
    4. IfAbruptCloseIterator(result, iterated).
    5. Set accumulator to result.
    6. Set counter to counter + 1.

27.1.4.10 Iterator.prototype.some ( predicate )

This method performs the following steps when called:

  1. Let O be the this value.
  2. If O is not an Object, throw a TypeError exception.
  3. Let iterated be the Iterator Record { [[Iterator]]: O, [[NextMethod]]: undefined, [[Done]]: false }.
  4. If IsCallable(predicate) is false, then
    1. Let error be ThrowCompletion(a newly created TypeError object).
    2. Return ? IteratorClose(iterated, error).
  5. Set iterated to ? GetIteratorDirect(O).
  6. Let counter be 0.
  7. Repeat,
    1. Let value be ? IteratorStepValue(iterated).
    2. If value is done, return false.
    3. Let result be Completion(Call(predicate, undefined, « value, 𝔽(counter) »)).
    4. IfAbruptCloseIterator(result, iterated).
    5. If ToBoolean(result) is true, return ? IteratorClose(iterated, NormalCompletion(true)).
    6. Set counter to counter + 1.

27.1.4.11 Iterator.prototype.take ( limit )

This method performs the following steps when called:

  1. Let O be the this value.
  2. If O is not an Object, throw a TypeError exception.
  3. Let iterated be the Iterator Record { [[Iterator]]: O, [[NextMethod]]: undefined, [[Done]]: false }.
  4. Let numLimit be Completion(ToNumber(limit)).
  5. IfAbruptCloseIterator(numLimit, iterated).
  6. If numLimit is NaN, then
    1. Let error be ThrowCompletion(a newly created RangeError object).
    2. Return ? IteratorClose(iterated, error).
  7. Let integerLimit be ! ToIntegerOrInfinity(numLimit).
  8. If integerLimit < 0, then
    1. Let error be ThrowCompletion(a newly created RangeError object).
    2. Return ? IteratorClose(iterated, error).
  9. Set iterated to ? GetIteratorDirect(O).
  10. Let closure be a new Abstract Closure with no parameters that captures iterated and integerLimit and performs the following steps when called:
    1. Let remaining be integerLimit.
    2. Repeat,
      1. If remaining = 0, then
        1. Return ? IteratorClose(iterated, ReturnCompletion(undefined)).
      2. If remaining ≠ +∞, then
        1. Set remaining to remaining - 1.
      3. Let value be ? IteratorStepValue(iterated).
      4. If value is done, return ReturnCompletion(undefined).
      5. Let completion be Completion(Yield(value)).
      6. IfAbruptCloseIterator(completion, iterated).
  11. Let result be CreateIteratorFromClosure(closure, "Iterator Helper", %IteratorHelperPrototype%, « [[UnderlyingIterator]] »).
  12. Set result.[[UnderlyingIterator]] to iterated.
  13. Return result.

27.1.4.12 Iterator.prototype.toArray ( )

This method performs the following steps when called:

  1. Let O be the this value.
  2. If O is not an Object, throw a TypeError exception.
  3. Let iterated be ? GetIteratorDirect(O).
  4. Let items be a new empty List.
  5. Repeat,
    1. Let value be ? IteratorStepValue(iterated).
    2. If value is done, return CreateArrayFromList(items).
    3. Append value to items.

27.1.4.13 Iterator.prototype [ %Symbol.iterator% ] ( )

This function performs the following steps when called:

  1. Return the this value.

The value of the "name" property of this function is "[Symbol.iterator]".

27.1.4.14 Iterator.prototype [ %Symbol.toStringTag% ]

Iterator.prototype[%Symbol.toStringTag%] is an accessor property with attributes { [[Enumerable]]: false, [[Configurable]]: true }. The [[Get]] and [[Set]] attributes are defined as follows:

27.1.4.14.1 get Iterator.prototype [ %Symbol.toStringTag% ]

The value of the [[Get]] attribute is a built-in function that requires no arguments. It performs the following steps when called:

  1. Return "Iterator".

27.1.4.14.2 set Iterator.prototype [ %Symbol.toStringTag% ]

The value of the [[Set]] attribute is a built-in function that takes an argument v. It performs the following steps when called:

  1. Perform ? SetterThatIgnoresPrototypeProperties(this value, %Iterator.prototype%, %Symbol.toStringTag%, v).
  2. Return undefined.
Note

Unlike the %Symbol.toStringTag% property on most built-in prototypes, for web-compatibility reasons this property must be an accessor.

27.1.5 The %AsyncIteratorPrototype% Object

The %AsyncIteratorPrototype% object:

Note

All objects defined in this specification that implement the async iterator interface also inherit from %AsyncIteratorPrototype%. ECMAScript code may also define objects that inherit from %AsyncIteratorPrototype%. The %AsyncIteratorPrototype% object provides a place where additional methods that are applicable to all async iterator objects may be added.

27.1.5.1 %AsyncIteratorPrototype% [ %Symbol.asyncIterator% ] ( )

This function performs the following steps when called:

  1. Return the this value.

The value of the "name" property of this function is "[Symbol.asyncIterator]".

27.1.6 Async-from-Sync Iterator Objects

An Async-from-Sync Iterator object is an async iterator that adapts a specific synchronous iterator. Async-from-Sync Iterator objects are never directly accessible to ECMAScript code. There is not a named constructor for Async-from-Sync Iterator objects. Instead, Async-from-Sync Iterator objects are created by the CreateAsyncFromSyncIterator abstract operation as needed.

27.1.6.1 CreateAsyncFromSyncIterator ( syncIteratorRecord )

The abstract operation CreateAsyncFromSyncIterator takes argument syncIteratorRecord (an Iterator Record) and returns an Iterator Record. It is used to create an async Iterator Record from a synchronous Iterator Record. It performs the following steps when called:

  1. Let asyncIterator be OrdinaryObjectCreate(%AsyncFromSyncIteratorPrototype%, « [[SyncIteratorRecord]] »).
  2. Set asyncIterator.[[SyncIteratorRecord]] to syncIteratorRecord.
  3. Let nextMethod be ! Get(asyncIterator, "next").
  4. Let iteratorRecord be the Iterator Record { [[Iterator]]: asyncIterator, [[NextMethod]]: nextMethod, [[Done]]: false }.
  5. Return iteratorRecord.

27.1.6.2 The %AsyncFromSyncIteratorPrototype% Object

The %AsyncFromSyncIteratorPrototype% object:

27.1.6.2.1 %AsyncFromSyncIteratorPrototype%.next ( [ value ] )

  1. Let O be the this value.
  2. Assert: O is an Object that has a [[SyncIteratorRecord]] internal slot.
  3. Let promiseCapability be ! NewPromiseCapability(%Promise%).
  4. Let syncIteratorRecord be O.[[SyncIteratorRecord]].
  5. If value is present, then
    1. Let result be Completion(IteratorNext(syncIteratorRecord, value)).
  6. Else,
    1. Let result be Completion(IteratorNext(syncIteratorRecord)).
  7. IfAbruptRejectPromise(result, promiseCapability).
  8. Return AsyncFromSyncIteratorContinuation(result, promiseCapability, syncIteratorRecord, true).

27.1.6.2.2 %AsyncFromSyncIteratorPrototype%.return ( [ value ] )

  1. Let O be the this value.
  2. Assert: O is an Object that has a [[SyncIteratorRecord]] internal slot.
  3. Let promiseCapability be ! NewPromiseCapability(%Promise%).
  4. Let syncIteratorRecord be O.[[SyncIteratorRecord]].
  5. Let syncIterator be syncIteratorRecord.[[Iterator]].
  6. Let return be Completion(GetMethod(syncIterator, "return")).
  7. IfAbruptRejectPromise(return, promiseCapability).
  8. If return is undefined, then
    1. Let iteratorResult be CreateIteratorResultObject(value, true).
    2. Perform ! Call(promiseCapability.[[Resolve]], undefined, « iteratorResult »).
    3. Return promiseCapability.[[Promise]].
  9. If value is present, then
    1. Let result be Completion(Call(return, syncIterator, « value »)).
  10. Else,
    1. Let result be Completion(Call(return, syncIterator)).
  11. IfAbruptRejectPromise(result, promiseCapability).
  12. If result is not an Object, then
    1. Perform ! Call(promiseCapability.[[Reject]], undefined, « a newly created TypeError object »).
    2. Return promiseCapability.[[Promise]].
  13. Return AsyncFromSyncIteratorContinuation(result, promiseCapability, syncIteratorRecord, false).

27.1.6.2.3 %AsyncFromSyncIteratorPrototype%.throw ( [ value ] )

Note
In this specification, value is always provided, but is left optional for consistency with %AsyncFromSyncIteratorPrototype%.return ( [ value ] ).
  1. Let O be the this value.
  2. Assert: O is an Object that has a [[SyncIteratorRecord]] internal slot.
  3. Let promiseCapability be ! NewPromiseCapability(%Promise%).
  4. Let syncIteratorRecord be O.[[SyncIteratorRecord]].
  5. Let syncIterator be syncIteratorRecord.[[Iterator]].
  6. Let throw be Completion(GetMethod(syncIterator, "throw")).
  7. IfAbruptRejectPromise(throw, promiseCapability).
  8. If throw is undefined, then
    1. NOTE: If syncIterator does not have a throw method, close it to give it a chance to clean up before we reject the capability.
    2. Let closeCompletion be NormalCompletion(empty).
    3. Let result be Completion(IteratorClose(syncIteratorRecord, closeCompletion)).
    4. IfAbruptRejectPromise(result, promiseCapability).
    5. NOTE: The next step throws a TypeError to indicate that there was a protocol violation: syncIterator does not have a throw method.
    6. NOTE: If closing syncIterator does not throw then the result of that operation is ignored, even if it yields a rejected promise.
    7. Perform ! Call(promiseCapability.[[Reject]], undefined, « a newly created TypeError object »).
    8. Return promiseCapability.[[Promise]].
  9. If value is present, then
    1. Let result be Completion(Call(throw, syncIterator, « value »)).
  10. Else,
    1. Let result be Completion(Call(throw, syncIterator)).
  11. IfAbruptRejectPromise(result, promiseCapability).
  12. If result is not an Object, then
    1. Perform ! Call(promiseCapability.[[Reject]], undefined, « a newly created TypeError object »).
    2. Return promiseCapability.[[Promise]].
  13. Return AsyncFromSyncIteratorContinuation(result, promiseCapability, syncIteratorRecord, true).

27.1.6.3 Properties of Async-from-Sync Iterator Instances

Async-from-Sync Iterator instances are ordinary objects that inherit properties from the %AsyncFromSyncIteratorPrototype% intrinsic object. Async-from-Sync Iterator instances are initially created with the internal slots listed in Table 89.

Table 89: Internal Slots of Async-from-Sync Iterator Instances
Internal Slot Type Description
[[SyncIteratorRecord]] an Iterator Record Represents the original synchronous iterator which is being adapted.

27.1.6.4 AsyncFromSyncIteratorContinuation ( result, promiseCapability, syncIteratorRecord, closeOnRejection )

The abstract operation AsyncFromSyncIteratorContinuation takes arguments result (an Object), promiseCapability (a PromiseCapability Record for an intrinsic %Promise%), syncIteratorRecord (an Iterator Record), and closeOnRejection (a Boolean) and returns a Promise. It performs the following steps when called:

  1. NOTE: Because promiseCapability is derived from the intrinsic %Promise%, the calls to promiseCapability.[[Reject]] entailed by the use IfAbruptRejectPromise below are guaranteed not to throw.
  2. Let done be Completion(IteratorComplete(result)).
  3. IfAbruptRejectPromise(done, promiseCapability).
  4. Let value be Completion(IteratorValue(result)).
  5. IfAbruptRejectPromise(value, promiseCapability).
  6. Let valueWrapper be Completion(PromiseResolve(%Promise%, value)).
  7. If valueWrapper is an abrupt completion, done is false, and closeOnRejection is true, then
    1. Set valueWrapper to Completion(IteratorClose(syncIteratorRecord, valueWrapper)).
  8. IfAbruptRejectPromise(valueWrapper, promiseCapability).
  9. Let unwrap be a new Abstract Closure with parameters (v) that captures done and performs the following steps when called:
    1. Return CreateIteratorResultObject(v, done).
  10. Let onFulfilled be CreateBuiltinFunction(unwrap, 1, "", « »).
  11. NOTE: onFulfilled is used when processing the "value" property of an IteratorResult object in order to wait for its value if it is a promise and re-package the result in a new "unwrapped" IteratorResult object.
  12. If done is true, or if closeOnRejection is false, then
    1. Let onRejected be undefined.
  13. Else,
    1. Let closeIterator be a new Abstract Closure with parameters (error) that captures syncIteratorRecord and performs the following steps when called:
      1. Return ? IteratorClose(syncIteratorRecord, ThrowCompletion(error)).
    2. Let onRejected be CreateBuiltinFunction(closeIterator, 1, "", « »).
    3. NOTE: onRejected is used to close the Iterator when the "value" property of an IteratorResult object it yields is a rejected promise.
  14. Perform PerformPromiseThen(valueWrapper, onFulfilled, onRejected, promiseCapability).
  15. Return promiseCapability.[[Promise]].

27.2 Promise Objects

A Promise is an object that is used as a placeholder for the eventual results of a deferred (and possibly asynchronous) computation.

Any Promise is in one of three mutually exclusive states: fulfilled, rejected, and pending:

  • A promise p is fulfilled if p.then(f, r) will immediately enqueue a Job to call the function f.
  • A promise p is rejected if p.then(f, r) will immediately enqueue a Job to call the function r.
  • A promise is pending if it is neither fulfilled nor rejected.

A promise is said to be settled if it is not pending, i.e. if it is either fulfilled or rejected.

A promise is resolved if it is settled or if it has been “locked in” to match the state of another promise. Attempting to resolve or reject a resolved promise has no effect. A promise is unresolved if it is not resolved. An unresolved promise is always in the pending state. A resolved promise may be pending, fulfilled or rejected.

27.2.1 Promise Abstract Operations

27.2.1.1 PromiseCapability Records

A PromiseCapability Record is a Record value used to encapsulate a Promise or promise-like object along with the functions that are capable of resolving or rejecting that promise. PromiseCapability Records are produced by the NewPromiseCapability abstract operation.

PromiseCapability Records have the fields listed in Table 90.

Table 90: PromiseCapability Record Fields
Field Name Value Meaning
[[Promise]] an Object An object that is usable as a promise.
[[Resolve]] a function object The function that is used to resolve the given promise.
[[Reject]] a function object The function that is used to reject the given promise.

27.2.1.1.1 IfAbruptRejectPromise ( value, capability )

IfAbruptRejectPromise is a shorthand for a sequence of algorithm steps that use a PromiseCapability Record. An algorithm step of the form:

  1. IfAbruptRejectPromise(value, capability).

means the same thing as:

  1. Assert: value is a Completion Record.
  2. If value is an abrupt completion, then
    1. Perform ? Call(capability.[[Reject]], undefined, « value.[[Value]] »).
    2. Return capability.[[Promise]].
  3. Else,
    1. Set value to ! value.

27.2.1.2 PromiseReaction Records

A PromiseReaction Record is a Record value used to store information about how a promise should react when it becomes resolved or rejected with a given value. PromiseReaction Records are created by the PerformPromiseThen abstract operation, and are used by the Abstract Closure returned by NewPromiseReactionJob.

PromiseReaction Records have the fields listed in Table 91.

Table 91: PromiseReaction Record Fields
Field Name Value Meaning
[[Capability]] a PromiseCapability Record or undefined The capabilities of the promise for which this record provides a reaction handler.
[[Type]] fulfill or reject The [[Type]] is used when [[Handler]] is empty to allow for behaviour specific to the settlement type.
[[Handler]] a JobCallback Record or empty The function that should be applied to the incoming value, and whose return value will govern what happens to the derived promise. If [[Handler]] is empty, a function that depends on the value of [[Type]] will be used instead.

27.2.1.3 CreateResolvingFunctions ( promise )

The abstract operation CreateResolvingFunctions takes argument promise (a Promise) and returns a Record with fields [[Resolve]] (a function object) and [[Reject]] (a function object). It performs the following steps when called:

  1. Let alreadyResolved be the Record { [[Value]]: false }.
  2. Let stepsResolve be the algorithm steps defined in Promise Resolve Functions.
  3. Let lengthResolve be the number of non-optional parameters of the function definition in Promise Resolve Functions.
  4. Let resolve be CreateBuiltinFunction(stepsResolve, lengthResolve, "", « [[Promise]], [[AlreadyResolved]] »).
  5. Set resolve.[[Promise]] to promise.
  6. Set resolve.[[AlreadyResolved]] to alreadyResolved.
  7. Let stepsReject be the algorithm steps defined in Promise Reject Functions.
  8. Let lengthReject be the number of non-optional parameters of the function definition in Promise Reject Functions.
  9. Let reject be CreateBuiltinFunction(stepsReject, lengthReject, "", « [[Promise]], [[AlreadyResolved]] »).
  10. Set reject.[[Promise]] to promise.
  11. Set reject.[[AlreadyResolved]] to alreadyResolved.
  12. Return the Record { [[Resolve]]: resolve, [[Reject]]: reject }.

27.2.1.3.1 Promise Reject Functions

A promise reject function is an anonymous built-in function that has [[Promise]] and [[AlreadyResolved]] internal slots.

When a promise reject function is called with argument reason, the following steps are taken:

  1. Let F be the active function object.
  2. Assert: F has a [[Promise]] internal slot whose value is an Object.
  3. Let promise be F.[[Promise]].
  4. Let alreadyResolved be F.[[AlreadyResolved]].
  5. If alreadyResolved.[[Value]] is true, return undefined.
  6. Set alreadyResolved.[[Value]] to true.
  7. Perform RejectPromise(promise, reason).
  8. Return undefined.

The "length" property of a promise reject function is 1𝔽.

27.2.1.3.2 Promise Resolve Functions

A promise resolve function is an anonymous built-in function that has [[Promise]] and [[AlreadyResolved]] internal slots.

When a promise resolve function is called with argument resolution, the following steps are taken:

  1. Let F be the active function object.
  2. Assert: F has a [[Promise]] internal slot whose value is an Object.
  3. Let promise be F.[[Promise]].
  4. Let alreadyResolved be F.[[AlreadyResolved]].
  5. If alreadyResolved.[[Value]] is true, return undefined.
  6. Set alreadyResolved.[[Value]] to true.
  7. If SameValue(resolution, promise) is true, then
    1. Let selfResolutionError be a newly created TypeError object.
    2. Perform RejectPromise(promise, selfResolutionError).
    3. Return undefined.
  8. If resolution is not an Object, then
    1. Perform FulfillPromise(promise, resolution).
    2. Return undefined.
  9. Let then be Completion(Get(resolution, "then")).
  10. If then is an abrupt completion, then
    1. Perform RejectPromise(promise, then.[[Value]]).
    2. Return undefined.
  11. Let thenAction be then.[[Value]].
  12. If IsCallable(thenAction) is false, then
    1. Perform FulfillPromise(promise, resolution).
    2. Return undefined.
  13. Let thenJobCallback be HostMakeJobCallback(thenAction).
  14. Let job be NewPromiseResolveThenableJob(promise, resolution, thenJobCallback).
  15. Perform HostEnqueuePromiseJob(job.[[Job]], job.[[Realm]]).
  16. Return undefined.

The "length" property of a promise resolve function is 1𝔽.

27.2.1.4 FulfillPromise ( promise, value )

The abstract operation FulfillPromise takes arguments promise (a Promise) and value (an ECMAScript language value) and returns unused. It performs the following steps when called:

  1. Assert: promise.[[PromiseState]] is pending.
  2. Let reactions be promise.[[PromiseFulfillReactions]].
  3. Set promise.[[PromiseResult]] to value.
  4. Set promise.[[PromiseFulfillReactions]] to undefined.
  5. Set promise.[[PromiseRejectReactions]] to undefined.
  6. Set promise.[[PromiseState]] to fulfilled.
  7. Perform TriggerPromiseReactions(reactions, value).
  8. Return unused.

27.2.1.5 NewPromiseCapability ( C )

The abstract operation NewPromiseCapability takes argument C (an ECMAScript language value) and returns either a normal completion containing a PromiseCapability Record or a throw completion. It attempts to use C as a constructor in the fashion of the built-in Promise constructor to create a promise and extract its resolve and reject functions. The promise plus the resolve and reject functions are used to initialize a new PromiseCapability Record. It performs the following steps when called:

  1. If IsConstructor(C) is false, throw a TypeError exception.
  2. NOTE: C is assumed to be a constructor function that supports the parameter conventions of the Promise constructor (see 27.2.3.1).
  3. Let resolvingFunctions be the Record { [[Resolve]]: undefined, [[Reject]]: undefined }.
  4. Let executorClosure be a new Abstract Closure with parameters (resolve, reject) that captures resolvingFunctions and performs the following steps when called:
    1. If resolvingFunctions.[[Resolve]] is not undefined, throw a TypeError exception.
    2. If resolvingFunctions.[[Reject]] is not undefined, throw a TypeError exception.
    3. Set resolvingFunctions.[[Resolve]] to resolve.
    4. Set resolvingFunctions.[[Reject]] to reject.
    5. Return NormalCompletion(undefined).
  5. Let executor be CreateBuiltinFunction(executorClosure, 2, "", « »).
  6. Let promise be ? Construct(C, « executor »).
  7. If IsCallable(resolvingFunctions.[[Resolve]]) is false, throw a TypeError exception.
  8. If IsCallable(resolvingFunctions.[[Reject]]) is false, throw a TypeError exception.
  9. Return the PromiseCapability Record { [[Promise]]: promise, [[Resolve]]: resolvingFunctions.[[Resolve]], [[Reject]]: resolvingFunctions.[[Reject]] }.
Note

This abstract operation supports Promise subclassing, as it is generic on any constructor that calls a passed executor function argument in the same way as the Promise constructor. It is used to generalize static methods of the Promise constructor to any subclass.

27.2.1.6 IsPromise ( x )

The abstract operation IsPromise takes argument x (an ECMAScript language value) and returns a Boolean. It checks for the promise brand on an object. It performs the following steps when called:

  1. If x is not an Object, return false.
  2. If x does not have a [[PromiseState]] internal slot, return false.
  3. Return true.

27.2.1.7 RejectPromise ( promise, reason )

The abstract operation RejectPromise takes arguments promise (a Promise) and reason (an ECMAScript language value) and returns unused. It performs the following steps when called:

  1. Assert: promise.[[PromiseState]] is pending.
  2. Let reactions be promise.[[PromiseRejectReactions]].
  3. Set promise.[[PromiseResult]] to reason.
  4. Set promise.[[PromiseFulfillReactions]] to undefined.
  5. Set promise.[[PromiseRejectReactions]] to undefined.
  6. Set promise.[[PromiseState]] to rejected.
  7. If promise.[[PromiseIsHandled]] is false, perform HostPromiseRejectionTracker(promise, "reject").
  8. Perform TriggerPromiseReactions(reactions, reason).
  9. Return unused.

27.2.1.8 TriggerPromiseReactions ( reactions, argument )

The abstract operation TriggerPromiseReactions takes arguments reactions (a List of PromiseReaction Records) and argument (an ECMAScript language value) and returns unused. It enqueues a new Job for each record in reactions. Each such Job processes the [[Type]] and [[Handler]] of the PromiseReaction Record, and if the [[Handler]] is not empty, calls it passing the given argument. If the [[Handler]] is empty, the behaviour is determined by the [[Type]]. It performs the following steps when called:

  1. For each element reaction of reactions, do
    1. Let job be NewPromiseReactionJob(reaction, argument).
    2. Perform HostEnqueuePromiseJob(job.[[Job]], job.[[Realm]]).
  2. Return unused.

27.2.1.9 HostPromiseRejectionTracker ( promise, operation )

The host-defined abstract operation HostPromiseRejectionTracker takes arguments promise (a Promise) and operation ("reject" or "handle") and returns unused. It allows host environments to track promise rejections.

The default implementation of HostPromiseRejectionTracker is to return unused.

Note 1

HostPromiseRejectionTracker is called in two scenarios:

  • When a promise is rejected without any handlers, it is called with its operation argument set to "reject".
  • When a handler is added to a rejected promise for the first time, it is called with its operation argument set to "handle".

A typical implementation of HostPromiseRejectionTracker might try to notify developers of unhandled rejections, while also being careful to notify them if such previous notifications are later invalidated by new handlers being attached.

Note 2

If operation is "handle", an implementation should not hold a reference to promise in a way that would interfere with garbage collection. An implementation may hold a reference to promise if operation is "reject", since it is expected that rejections will be rare and not on hot code paths.

27.2.2 Promise Jobs

27.2.2.1 NewPromiseReactionJob ( reaction, argument )

The abstract operation NewPromiseReactionJob takes arguments reaction (a PromiseReaction Record) and argument (an ECMAScript language value) and returns a Record with fields [[Job]] (a Job Abstract Closure) and [[Realm]] (a Realm Record or null). It returns a new Job Abstract Closure that applies the appropriate handler to the incoming value, and uses the handler's return value to resolve or reject the derived promise associated with that handler. It performs the following steps when called:

  1. Let job be a new Job Abstract Closure with no parameters that captures reaction and argument and performs the following steps when called:
    1. Let promiseCapability be reaction.[[Capability]].
    2. Let type be reaction.[[Type]].
    3. Let handler be reaction.[[Handler]].
    4. If handler is empty, then
      1. If type is fulfill, then
        1. Let handlerResult be NormalCompletion(argument).
      2. Else,
        1. Assert: type is reject.
        2. Let handlerResult be ThrowCompletion(argument).
    5. Else,
      1. Let handlerResult be Completion(HostCallJobCallback(handler, undefined, « argument »)).
    6. If promiseCapability is undefined, then
      1. Assert: handlerResult is not an abrupt completion.
      2. Return empty.
    7. Assert: promiseCapability is a PromiseCapability Record.
    8. If handlerResult is an abrupt completion, then
      1. Return ? Call(promiseCapability.[[Reject]], undefined, « handlerResult.[[Value]] »).
    9. Else,
      1. Return ? Call(promiseCapability.[[Resolve]], undefined, « handlerResult.[[Value]] »).
  2. Let handlerRealm be null.
  3. If reaction.[[Handler]] is not empty, then
    1. Let getHandlerRealmResult be Completion(GetFunctionRealm(reaction.[[Handler]].[[Callback]])).
    2. If getHandlerRealmResult is a normal completion, set handlerRealm to getHandlerRealmResult.[[Value]].
    3. Else, set handlerRealm to the current Realm Record.
    4. NOTE: handlerRealm is never null unless the handler is undefined. When the handler is a revoked Proxy and no ECMAScript code runs, handlerRealm is used to create error objects.
  4. Return the Record { [[Job]]: job, [[Realm]]: handlerRealm }.

27.2.2.2 NewPromiseResolveThenableJob ( promiseToResolve, thenable, then )

The abstract operation NewPromiseResolveThenableJob takes arguments promiseToResolve (a Promise), thenable (an Object), and then (a JobCallback Record) and returns a Record with fields [[Job]] (a Job Abstract Closure) and [[Realm]] (a Realm Record). It performs the following steps when called:

  1. Let job be a new Job Abstract Closure with no parameters that captures promiseToResolve, thenable, and then and performs the following steps when called:
    1. Let resolvingFunctions be CreateResolvingFunctions(promiseToResolve).
    2. Let thenCallResult be Completion(HostCallJobCallback(then, thenable, « resolvingFunctions.[[Resolve]], resolvingFunctions.[[Reject]] »)).
    3. If thenCallResult is an abrupt completion, then
      1. Return ? Call(resolvingFunctions.[[Reject]], undefined, « thenCallResult.[[Value]] »).
    4. Return ! thenCallResult.
  2. Let getThenRealmResult be Completion(GetFunctionRealm(then.[[Callback]])).
  3. If getThenRealmResult is a normal completion, let thenRealm be getThenRealmResult.[[Value]].
  4. Else, let thenRealm be the current Realm Record.
  5. NOTE: thenRealm is never null. When then.[[Callback]] is a revoked Proxy and no code runs, thenRealm is used to create error objects.
  6. Return the Record { [[Job]]: job, [[Realm]]: thenRealm }.
Note

This Job uses the supplied thenable and its then method to resolve the given promise. This process must take place as a Job to ensure that the evaluation of the then method occurs after evaluation of any surrounding code has completed.

27.2.3 The Promise Constructor

The Promise constructor:

  • is %Promise%.
  • is the initial value of the "Promise" property of the global object.
  • creates and initializes a new Promise when called as a constructor.
  • is not intended to be called as a function and will throw an exception when called in that manner.
  • may be used as the value in an extends clause of a class definition. Subclass constructors that intend to inherit the specified Promise behaviour must include a super call to the Promise constructor to create and initialize the subclass instance with the internal state necessary to support the Promise and Promise.prototype built-in methods.

27.2.3.1 Promise ( executor )

This function performs the following steps when called:

  1. If NewTarget is undefined, throw a TypeError exception.
  2. If IsCallable(executor) is false, throw a TypeError exception.
  3. Let promise be ? OrdinaryCreateFromConstructor(NewTarget, "%Promise.prototype%", « [[PromiseState]], [[PromiseResult]], [[PromiseFulfillReactions]], [[PromiseRejectReactions]], [[PromiseIsHandled]] »).
  4. Set promise.[[PromiseState]] to pending.
  5. Set promise.[[PromiseResult]] to empty.
  6. Set promise.[[PromiseFulfillReactions]] to a new empty List.
  7. Set promise.[[PromiseRejectReactions]] to a new empty List.
  8. Set promise.[[PromiseIsHandled]] to false.
  9. Let resolvingFunctions be CreateResolvingFunctions(promise).
  10. Let completion be Completion(Call(executor, undefined, « resolvingFunctions.[[Resolve]], resolvingFunctions.[[Reject]] »)).
  11. If completion is an abrupt completion, then
    1. Perform ? Call(resolvingFunctions.[[Reject]], undefined, « completion.[[Value]] »).
  12. Return promise.
Note

The executor argument must be a function object. It is called for initiating and reporting completion of the possibly deferred action represented by this Promise. The executor is called with two arguments: resolve and reject. These are functions that may be used by the executor function to report eventual completion or failure of the deferred computation. Returning from the executor function does not mean that the deferred action has been completed but only that the request to eventually perform the deferred action has been accepted.

The resolve function that is passed to an executor function accepts a single argument. The executor code may eventually call the resolve function to indicate that it wishes to resolve the associated Promise. The argument passed to the resolve function represents the eventual value of the deferred action and can be either the actual fulfillment value or another promise which will provide the value if it is fulfilled.

The reject function that is passed to an executor function accepts a single argument. The executor code may eventually call the reject function to indicate that the associated Promise is rejected and will never be fulfilled. The argument passed to the reject function is used as the rejection value of the promise. Typically it will be an Error object.

The resolve and reject functions passed to an executor function by the Promise constructor have the capability to actually resolve and reject the associated promise. Subclasses may have different constructor behaviour that passes in customized values for resolve and reject.

27.2.4 Properties of the Promise Constructor

The Promise constructor:

  • has a [[Prototype]] internal slot whose value is %Function.prototype%.
  • has the following properties:

27.2.4.1 Promise.all ( iterable )

This function returns a new promise which is fulfilled with an array of fulfillment values for the passed promises, or rejects with the reason of the first passed promise that rejects. It resolves all elements of the passed iterable to promises as it runs this algorithm.

  1. Let C be the this value.
  2. Let promiseCapability be ? NewPromiseCapability(C).
  3. Let promiseResolve be Completion(GetPromiseResolve(C)).
  4. IfAbruptRejectPromise(promiseResolve, promiseCapability).
  5. Let iteratorRecord be Completion(GetIterator(iterable, sync)).
  6. IfAbruptRejectPromise(iteratorRecord, promiseCapability).
  7. Let result be Completion(PerformPromiseAll(iteratorRecord, C, promiseCapability, promiseResolve)).
  8. If result is an abrupt completion, then
    1. If iteratorRecord.[[Done]] is false, set result to Completion(IteratorClose(iteratorRecord, result)).
    2. IfAbruptRejectPromise(result, promiseCapability).
  9. Return ! result.
Note

This function requires its this value to be a constructor function that supports the parameter conventions of the Promise constructor.

27.2.4.1.1 GetPromiseResolve ( promiseConstructor )

The abstract operation GetPromiseResolve takes argument promiseConstructor (a constructor) and returns either a normal completion containing a function object or a throw completion. It performs the following steps when called:

  1. Let promiseResolve be ? Get(promiseConstructor, "resolve").
  2. If IsCallable(promiseResolve) is false, throw a TypeError exception.
  3. Return promiseResolve.

27.2.4.1.2 PerformPromiseAll ( iteratorRecord, constructor, resultCapability, promiseResolve )

The abstract operation PerformPromiseAll takes arguments iteratorRecord (an Iterator Record), constructor (a constructor), resultCapability (a PromiseCapability Record), and promiseResolve (a function object) and returns either a normal completion containing an ECMAScript language value or a throw completion. It performs the following steps when called:

  1. Let values be a new empty List.
  2. Let remainingElementsCount be the Record { [[Value]]: 1 }.
  3. Let index be 0.
  4. Repeat,
    1. Let next be ? IteratorStepValue(iteratorRecord).
    2. If next is done, then
      1. Set remainingElementsCount.[[Value]] to remainingElementsCount.[[Value]] - 1.
      2. If remainingElementsCount.[[Value]] = 0, then
        1. Let valuesArray be CreateArrayFromList(values).
        2. Perform ? Call(resultCapability.[[Resolve]], undefined, « valuesArray »).
      3. Return resultCapability.[[Promise]].
    3. Append undefined to values.
    4. Let nextPromise be ? Call(promiseResolve, constructor, « next »).
    5. Let steps be the algorithm steps defined in Promise.all Resolve Element Functions.
    6. Let length be the number of non-optional parameters of the function definition in Promise.all Resolve Element Functions.
    7. Let onFulfilled be CreateBuiltinFunction(steps, length, "", « [[AlreadyCalled]], [[Index]], [[Values]], [[Capability]], [[RemainingElements]] »).
    8. Set onFulfilled.[[AlreadyCalled]] to false.
    9. Set onFulfilled.[[Index]] to index.
    10. Set onFulfilled.[[Values]] to values.
    11. Set onFulfilled.[[Capability]] to resultCapability.
    12. Set onFulfilled.[[RemainingElements]] to remainingElementsCount.
    13. Set remainingElementsCount.[[Value]] to remainingElementsCount.[[Value]] + 1.
    14. Perform ? Invoke(nextPromise, "then", « onFulfilled, resultCapability.[[Reject]] »).
    15. Set index to index + 1.

27.2.4.1.3 Promise.all Resolve Element Functions

A Promise.all resolve element function is an anonymous built-in function that is used to resolve a specific Promise.all element. Each Promise.all resolve element function has [[Index]], [[Values]], [[Capability]], [[RemainingElements]], and [[AlreadyCalled]] internal slots.

When a Promise.all resolve element function is called with argument x, the following steps are taken:

  1. Let F be the active function object.
  2. If F.[[AlreadyCalled]] is true, return undefined.
  3. Set F.[[AlreadyCalled]] to true.
  4. Let index be F.[[Index]].
  5. Let values be F.[[Values]].
  6. Let promiseCapability be F.[[Capability]].
  7. Let remainingElementsCount be F.[[RemainingElements]].
  8. Set values[index] to x.
  9. Set remainingElementsCount.[[Value]] to remainingElementsCount.[[Value]] - 1.
  10. If remainingElementsCount.[[Value]] = 0, then
    1. Let valuesArray be CreateArrayFromList(values).
    2. Return ? Call(promiseCapability.[[Resolve]], undefined, « valuesArray »).
  11. Return undefined.

The "length" property of a Promise.all resolve element function is 1𝔽.

27.2.4.2 Promise.allSettled ( iterable )

This function returns a promise that is fulfilled with an array of promise state snapshots, but only after all the original promises have settled, i.e. become either fulfilled or rejected. It resolves all elements of the passed iterable to promises as it runs this algorithm.

  1. Let C be the this value.
  2. Let promiseCapability be ? NewPromiseCapability(C).
  3. Let promiseResolve be Completion(GetPromiseResolve(C)).
  4. IfAbruptRejectPromise(promiseResolve, promiseCapability).
  5. Let iteratorRecord be Completion(GetIterator(iterable, sync)).
  6. IfAbruptRejectPromise(iteratorRecord, promiseCapability).
  7. Let result be Completion(PerformPromiseAllSettled(iteratorRecord, C, promiseCapability, promiseResolve)).
  8. If result is an abrupt completion, then
    1. If iteratorRecord.[[Done]] is false, set result to Completion(IteratorClose(iteratorRecord, result)).
    2. IfAbruptRejectPromise(result, promiseCapability).
  9. Return ! result.
Note

This function requires its this value to be a constructor function that supports the parameter conventions of the Promise constructor.

27.2.4.2.1 PerformPromiseAllSettled ( iteratorRecord, constructor, resultCapability, promiseResolve )

The abstract operation PerformPromiseAllSettled takes arguments iteratorRecord (an Iterator Record), constructor (a constructor), resultCapability (a PromiseCapability Record), and promiseResolve (a function object) and returns either a normal completion containing an ECMAScript language value or a throw completion. It performs the following steps when called:

  1. Let values be a new empty List.
  2. Let remainingElementsCount be the Record { [[Value]]: 1 }.
  3. Let index be 0.
  4. Repeat,
    1. Let next be ? IteratorStepValue(iteratorRecord).
    2. If next is done, then
      1. Set remainingElementsCount.[[Value]] to remainingElementsCount.[[Value]] - 1.
      2. If remainingElementsCount.[[Value]] = 0, then
        1. Let valuesArray be CreateArrayFromList(values).
        2. Perform ? Call(resultCapability.[[Resolve]], undefined, « valuesArray »).
      3. Return resultCapability.[[Promise]].
    3. Append undefined to values.
    4. Let nextPromise be ? Call(promiseResolve, constructor, « next »).
    5. Let stepsFulfilled be the algorithm steps defined in Promise.allSettled Resolve Element Functions.
    6. Let lengthFulfilled be the number of non-optional parameters of the function definition in Promise.allSettled Resolve Element Functions.
    7. Let onFulfilled be CreateBuiltinFunction(stepsFulfilled, lengthFulfilled, "", « [[AlreadyCalled]], [[Index]], [[Values]], [[Capability]], [[RemainingElements]] »).
    8. Let alreadyCalled be the Record { [[Value]]: false }.
    9. Set onFulfilled.[[AlreadyCalled]] to alreadyCalled.
    10. Set onFulfilled.[[Index]] to index.
    11. Set onFulfilled.[[Values]] to values.
    12. Set onFulfilled.[[Capability]] to resultCapability.
    13. Set onFulfilled.[[RemainingElements]] to remainingElementsCount.
    14. Let stepsRejected be the algorithm steps defined in Promise.allSettled Reject Element Functions.
    15. Let lengthRejected be the number of non-optional parameters of the function definition in Promise.allSettled Reject Element Functions.
    16. Let onRejected be CreateBuiltinFunction(stepsRejected, lengthRejected, "", « [[AlreadyCalled]], [[Index]], [[Values]], [[Capability]], [[RemainingElements]] »).
    17. Set onRejected.[[AlreadyCalled]] to alreadyCalled.
    18. Set onRejected.[[Index]] to index.
    19. Set onRejected.[[Values]] to values.
    20. Set onRejected.[[Capability]] to resultCapability.
    21. Set onRejected.[[RemainingElements]] to remainingElementsCount.
    22. Set remainingElementsCount.[[Value]] to remainingElementsCount.[[Value]] + 1.
    23. Perform ? Invoke(nextPromise, "then", « onFulfilled, onRejected »).
    24. Set index to index + 1.

27.2.4.2.2 Promise.allSettled Resolve Element Functions

A Promise.allSettled resolve element function is an anonymous built-in function that is used to resolve a specific Promise.allSettled element. Each Promise.allSettled resolve element function has [[Index]], [[Values]], [[Capability]], [[RemainingElements]], and [[AlreadyCalled]] internal slots.

When a Promise.allSettled resolve element function is called with argument x, the following steps are taken:

  1. Let F be the active function object.
  2. Let alreadyCalled be F.[[AlreadyCalled]].
  3. If alreadyCalled.[[Value]] is true, return undefined.
  4. Set alreadyCalled.[[Value]] to true.
  5. Let index be F.[[Index]].
  6. Let values be F.[[Values]].
  7. Let promiseCapability be F.[[Capability]].
  8. Let remainingElementsCount be F.[[RemainingElements]].
  9. Let obj be OrdinaryObjectCreate(%Object.prototype%).
  10. Perform ! CreateDataPropertyOrThrow(obj, "status", "fulfilled").
  11. Perform ! CreateDataPropertyOrThrow(obj, "value", x).
  12. Set values[index] to obj.
  13. Set remainingElementsCount.[[Value]] to remainingElementsCount.[[Value]] - 1.
  14. If remainingElementsCount.[[Value]] = 0, then
    1. Let valuesArray be CreateArrayFromList(values).
    2. Return ? Call(promiseCapability.[[Resolve]], undefined, « valuesArray »).
  15. Return undefined.

The "length" property of a Promise.allSettled resolve element function is 1𝔽.

27.2.4.2.3 Promise.allSettled Reject Element Functions

A Promise.allSettled reject element function is an anonymous built-in function that is used to reject a specific Promise.allSettled element. Each Promise.allSettled reject element function has [[Index]], [[Values]], [[Capability]], [[RemainingElements]], and [[AlreadyCalled]] internal slots.

When a Promise.allSettled reject element function is called with argument x, the following steps are taken:

  1. Let F be the active function object.
  2. Let alreadyCalled be F.[[AlreadyCalled]].
  3. If alreadyCalled.[[Value]] is true, return undefined.
  4. Set alreadyCalled.[[Value]] to true.
  5. Let index be F.[[Index]].
  6. Let values be F.[[Values]].
  7. Let promiseCapability be F.[[Capability]].
  8. Let remainingElementsCount be F.[[RemainingElements]].
  9. Let obj be OrdinaryObjectCreate(%Object.prototype%).
  10. Perform ! CreateDataPropertyOrThrow(obj, "status", "rejected").
  11. Perform ! CreateDataPropertyOrThrow(obj, "reason", x).
  12. Set values[index] to obj.
  13. Set remainingElementsCount.[[Value]] to remainingElementsCount.[[Value]] - 1.
  14. If remainingElementsCount.[[Value]] = 0, then
    1. Let valuesArray be CreateArrayFromList(values).
    2. Return ? Call(promiseCapability.[[Resolve]], undefined, « valuesArray »).
  15. Return undefined.

The "length" property of a Promise.allSettled reject element function is 1𝔽.

27.2.4.3 Promise.any ( iterable )

This function returns a promise that is fulfilled by the first given promise to be fulfilled, or rejected with an AggregateError holding the rejection reasons if all of the given promises are rejected. It resolves all elements of the passed iterable to promises as it runs this algorithm.

  1. Let C be the this value.
  2. Let promiseCapability be ? NewPromiseCapability(C).
  3. Let promiseResolve be Completion(GetPromiseResolve(C)).
  4. IfAbruptRejectPromise(promiseResolve, promiseCapability).
  5. Let iteratorRecord be Completion(GetIterator(iterable, sync)).
  6. IfAbruptRejectPromise(iteratorRecord, promiseCapability).
  7. Let result be Completion(PerformPromiseAny(iteratorRecord, C, promiseCapability, promiseResolve)).
  8. If result is an abrupt completion, then
    1. If iteratorRecord.[[Done]] is false, set result to Completion(IteratorClose(iteratorRecord, result)).
    2. IfAbruptRejectPromise(result, promiseCapability).
  9. Return ! result.
Note

This function requires its this value to be a constructor function that supports the parameter conventions of the Promise constructor.

27.2.4.3.1 PerformPromiseAny ( iteratorRecord, constructor, resultCapability, promiseResolve )

The abstract operation PerformPromiseAny takes arguments iteratorRecord (an Iterator Record), constructor (a constructor), resultCapability (a PromiseCapability Record), and promiseResolve (a function object) and returns either a normal completion containing an ECMAScript language value or a throw completion. It performs the following steps when called:

  1. Let errors be a new empty List.
  2. Let remainingElementsCount be the Record { [[Value]]: 1 }.
  3. Let index be 0.
  4. Repeat,
    1. Let next be ? IteratorStepValue(iteratorRecord).
    2. If next is done, then
      1. Set remainingElementsCount.[[Value]] to remainingElementsCount.[[Value]] - 1.
      2. If remainingElementsCount.[[Value]] = 0, then
        1. Let error be a newly created AggregateError object.
        2. Perform ! DefinePropertyOrThrow(error, "errors", PropertyDescriptor { [[Configurable]]: true, [[Enumerable]]: false, [[Writable]]: true, [[Value]]: CreateArrayFromList(errors) }).
        3. Return ThrowCompletion(error).
      3. Return resultCapability.[[Promise]].
    3. Append undefined to errors.
    4. Let nextPromise be ? Call(promiseResolve, constructor, « next »).
    5. Let stepsRejected be the algorithm steps defined in Promise.any Reject Element Functions.
    6. Let lengthRejected be the number of non-optional parameters of the function definition in Promise.any Reject Element Functions.
    7. Let onRejected be CreateBuiltinFunction(stepsRejected, lengthRejected, "", « [[AlreadyCalled]], [[Index]], [[Errors]], [[Capability]], [[RemainingElements]] »).
    8. Set onRejected.[[AlreadyCalled]] to false.
    9. Set onRejected.[[Index]] to index.
    10. Set onRejected.[[Errors]] to errors.
    11. Set onRejected.[[Capability]] to resultCapability.
    12. Set onRejected.[[RemainingElements]] to remainingElementsCount.
    13. Set remainingElementsCount.[[Value]] to remainingElementsCount.[[Value]] + 1.
    14. Perform ? Invoke(nextPromise, "then", « resultCapability.[[Resolve]], onRejected »).
    15. Set index to index + 1.

27.2.4.3.2 Promise.any Reject Element Functions

A Promise.any reject element function is an anonymous built-in function that is used to reject a specific Promise.any element. Each Promise.any reject element function has [[Index]], [[Errors]], [[Capability]], [[RemainingElements]], and [[AlreadyCalled]] internal slots.

When a Promise.any reject element function is called with argument x, the following steps are taken:

  1. Let F be the active function object.
  2. If F.[[AlreadyCalled]] is true, return undefined.
  3. Set F.[[AlreadyCalled]] to true.
  4. Let index be F.[[Index]].
  5. Let errors be F.[[Errors]].
  6. Let promiseCapability be F.[[Capability]].
  7. Let remainingElementsCount be F.[[RemainingElements]].
  8. Set errors[index] to x.
  9. Set remainingElementsCount.[[Value]] to remainingElementsCount.[[Value]] - 1.
  10. If remainingElementsCount.[[Value]] = 0, then
    1. Let error be a newly created AggregateError object.
    2. Perform ! DefinePropertyOrThrow(error, "errors", PropertyDescriptor { [[Configurable]]: true, [[Enumerable]]: false, [[Writable]]: true, [[Value]]: CreateArrayFromList(errors) }).
    3. Return ? Call(promiseCapability.[[Reject]], undefined, « error »).
  11. Return undefined.

The "length" property of a Promise.any reject element function is 1𝔽.

27.2.4.4 Promise.prototype

The initial value of Promise.prototype is the Promise prototype object.

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: false }.

27.2.4.5 Promise.race ( iterable )

This function returns a new promise which is settled in the same way as the first passed promise to settle. It resolves all elements of the passed iterable to promises as it runs this algorithm.

  1. Let C be the this value.
  2. Let promiseCapability be ? NewPromiseCapability(C).
  3. Let promiseResolve be Completion(GetPromiseResolve(C)).
  4. IfAbruptRejectPromise(promiseResolve, promiseCapability).
  5. Let iteratorRecord be Completion(GetIterator(iterable, sync)).
  6. IfAbruptRejectPromise(iteratorRecord, promiseCapability).
  7. Let result be Completion(PerformPromiseRace(iteratorRecord, C, promiseCapability, promiseResolve)).
  8. If result is an abrupt completion, then
    1. If iteratorRecord.[[Done]] is false, set result to Completion(IteratorClose(iteratorRecord, result)).
    2. IfAbruptRejectPromise(result, promiseCapability).
  9. Return ! result.
Note 1

If the iterable argument yields no values or if none of the promises yielded by iterable ever settle, then the pending promise returned by this method will never be settled.

Note 2

This function expects its this value to be a constructor function that supports the parameter conventions of the Promise constructor. It also expects that its this value provides a resolve method.

27.2.4.5.1 PerformPromiseRace ( iteratorRecord, constructor, resultCapability, promiseResolve )

The abstract operation PerformPromiseRace takes arguments iteratorRecord (an Iterator Record), constructor (a constructor), resultCapability (a PromiseCapability Record), and promiseResolve (a function object) and returns either a normal completion containing an ECMAScript language value or a throw completion. It performs the following steps when called:

  1. Repeat,
    1. Let next be ? IteratorStepValue(iteratorRecord).
    2. If next is done, then
      1. Return resultCapability.[[Promise]].
    3. Let nextPromise be ? Call(promiseResolve, constructor, « next »).
    4. Perform ? Invoke(nextPromise, "then", « resultCapability.[[Resolve]], resultCapability.[[Reject]] »).

27.2.4.6 Promise.reject ( r )

This function returns a new promise rejected with the passed argument.

  1. Let C be the this value.
  2. Let promiseCapability be ? NewPromiseCapability(C).
  3. Perform ? Call(promiseCapability.[[Reject]], undefined, « r »).
  4. Return promiseCapability.[[Promise]].
Note

This function expects its this value to be a constructor function that supports the parameter conventions of the Promise constructor.

27.2.4.7 Promise.resolve ( x )

This function returns either a new promise resolved with the passed argument, or the argument itself if the argument is a promise produced by this constructor.

  1. Let C be the this value.
  2. If C is not an Object, throw a TypeError exception.
  3. Return ? PromiseResolve(C, x).
Note

This function expects its this value to be a constructor function that supports the parameter conventions of the Promise constructor.

27.2.4.7.1 PromiseResolve ( C, x )

The abstract operation PromiseResolve takes arguments C (an Object) and x (an ECMAScript language value) and returns either a normal completion containing an ECMAScript language value or a throw completion. It returns a new promise resolved with x. It performs the following steps when called:

  1. If IsPromise(x) is true, then
    1. Let xConstructor be ? Get(x, "constructor").
    2. If SameValue(xConstructor, C) is true, return x.
  2. Let promiseCapability be ? NewPromiseCapability(C).
  3. Perform ? Call(promiseCapability.[[Resolve]], undefined, « x »).
  4. Return promiseCapability.[[Promise]].

27.2.4.8 Promise.try ( callback, ...args )

This function performs the following steps when called:

  1. Let C be the this value.
  2. If C is not an Object, throw a TypeError exception.
  3. Let promiseCapability be ? NewPromiseCapability(C).
  4. Let status be Completion(Call(callback, undefined, args)).
  5. If status is an abrupt completion, then
    1. Perform ? Call(promiseCapability.[[Reject]], undefined, « status.[[Value]] »).
  6. Else,
    1. Perform ? Call(promiseCapability.[[Resolve]], undefined, « status.[[Value]] »).
  7. Return promiseCapability.[[Promise]].
Note

This function expects its this value to be a constructor function that supports the parameter conventions of the Promise constructor.

27.2.4.9 Promise.withResolvers ( )

This function returns an object with three properties: a new promise together with the resolve and reject functions associated with it.

  1. Let C be the this value.
  2. Let promiseCapability be ? NewPromiseCapability(C).
  3. Let obj be OrdinaryObjectCreate(%Object.prototype%).
  4. Perform ! CreateDataPropertyOrThrow(obj, "promise", promiseCapability.[[Promise]]).
  5. Perform ! CreateDataPropertyOrThrow(obj, "resolve", promiseCapability.[[Resolve]]).
  6. Perform ! CreateDataPropertyOrThrow(obj, "reject", promiseCapability.[[Reject]]).
  7. Return obj.

27.2.4.10 get Promise [ %Symbol.species% ]

Promise[%Symbol.species%] is an accessor property whose set accessor function is undefined. Its get accessor function performs the following steps when called:

  1. Return the this value.

The value of the "name" property of this function is "get [Symbol.species]".

Note

Promise prototype methods normally use their this value's constructor to create a derived object. However, a subclass constructor may over-ride that default behaviour by redefining its %Symbol.species% property.

27.2.5 Properties of the Promise Prototype Object

The Promise prototype object:

  • is %Promise.prototype%.
  • has a [[Prototype]] internal slot whose value is %Object.prototype%.
  • is an ordinary object.
  • does not have a [[PromiseState]] internal slot or any of the other internal slots of Promise instances.

27.2.5.1 Promise.prototype.catch ( onRejected )

This method performs the following steps when called:

  1. Let promise be the this value.
  2. Return ? Invoke(promise, "then", « undefined, onRejected »).

27.2.5.2 Promise.prototype.constructor

The initial value of Promise.prototype.constructor is %Promise%.

27.2.5.3 Promise.prototype.finally ( onFinally )

This method performs the following steps when called:

  1. Let promise be the this value.
  2. If promise is not an Object, throw a TypeError exception.
  3. Let C be ? SpeciesConstructor(promise, %Promise%).
  4. Assert: IsConstructor(C) is true.
  5. If IsCallable(onFinally) is false, then
    1. Let thenFinally be onFinally.
    2. Let catchFinally be onFinally.
  6. Else,
    1. Let thenFinallyClosure be a new Abstract Closure with parameters (value) that captures onFinally and C and performs the following steps when called:
      1. Let result be ? Call(onFinally, undefined).
      2. Let p be ? PromiseResolve(C, result).
      3. Let returnValue be a new Abstract Closure with no parameters that captures value and performs the following steps when called:
        1. Return NormalCompletion(value).
      4. Let valueThunk be CreateBuiltinFunction(returnValue, 0, "", « »).
      5. Return ? Invoke(p, "then", « valueThunk »).
    2. Let thenFinally be CreateBuiltinFunction(thenFinallyClosure, 1, "", « »).
    3. Let catchFinallyClosure be a new Abstract Closure with parameters (reason) that captures onFinally and C and performs the following steps when called:
      1. Let result be ? Call(onFinally, undefined).
      2. Let p be ? PromiseResolve(C, result).
      3. Let throwReason be a new Abstract Closure with no parameters that captures reason and performs the following steps when called:
        1. Return ThrowCompletion(reason).
      4. Let thrower be CreateBuiltinFunction(throwReason, 0, "", « »).
      5. Return ? Invoke(p, "then", « thrower »).
    4. Let catchFinally be CreateBuiltinFunction(catchFinallyClosure, 1, "", « »).
  7. Return ? Invoke(promise, "then", « thenFinally, catchFinally »).

27.2.5.4 Promise.prototype.then ( onFulfilled, onRejected )

This method performs the following steps when called:

  1. Let promise be the this value.
  2. If IsPromise(promise) is false, throw a TypeError exception.
  3. Let C be ? SpeciesConstructor(promise, %Promise%).
  4. Let resultCapability be ? NewPromiseCapability(C).
  5. Return PerformPromiseThen(promise, onFulfilled, onRejected, resultCapability).

27.2.5.4.1 PerformPromiseThen ( promise, onFulfilled, onRejected [ , resultCapability ] )

The abstract operation PerformPromiseThen takes arguments promise (a Promise), onFulfilled (an ECMAScript language value), and onRejected (an ECMAScript language value) and optional argument resultCapability (a PromiseCapability Record) and returns an ECMAScript language value. It performs the “then” operation on promise using onFulfilled and onRejected as its settlement actions. If resultCapability is passed, the result is stored by updating resultCapability's promise. If it is not passed, then PerformPromiseThen is being called by a specification-internal operation where the result does not matter. It performs the following steps when called:

  1. Assert: IsPromise(promise) is true.
  2. If resultCapability is not present, then
    1. Set resultCapability to undefined.
  3. If IsCallable(onFulfilled) is false, then
    1. Let onFulfilledJobCallback be empty.
  4. Else,
    1. Let onFulfilledJobCallback be HostMakeJobCallback(onFulfilled).
  5. If IsCallable(onRejected) is false, then
    1. Let onRejectedJobCallback be empty.
  6. Else,
    1. Let onRejectedJobCallback be HostMakeJobCallback(onRejected).
  7. Let fulfillReaction be the PromiseReaction Record { [[Capability]]: resultCapability, [[Type]]: fulfill, [[Handler]]: onFulfilledJobCallback }.
  8. Let rejectReaction be the PromiseReaction Record { [[Capability]]: resultCapability, [[Type]]: reject, [[Handler]]: onRejectedJobCallback }.
  9. If promise.[[PromiseState]] is pending, then
    1. Append fulfillReaction to promise.[[PromiseFulfillReactions]].
    2. Append rejectReaction to promise.[[PromiseRejectReactions]].
  10. Else if promise.[[PromiseState]] is fulfilled, then
    1. Let value be promise.[[PromiseResult]].
    2. Let fulfillJob be NewPromiseReactionJob(fulfillReaction, value).
    3. Perform HostEnqueuePromiseJob(fulfillJob.[[Job]], fulfillJob.[[Realm]]).
  11. Else,
    1. Assert: promise.[[PromiseState]] is rejected.
    2. Let reason be promise.[[PromiseResult]].
    3. If promise.[[PromiseIsHandled]] is false, perform HostPromiseRejectionTracker(promise, "handle").
    4. Let rejectJob be NewPromiseReactionJob(rejectReaction, reason).
    5. Perform HostEnqueuePromiseJob(rejectJob.[[Job]], rejectJob.[[Realm]]).
  12. Set promise.[[PromiseIsHandled]] to true.
  13. If resultCapability is undefined, then
    1. Return undefined.
  14. Else,
    1. Return resultCapability.[[Promise]].

27.2.5.5 Promise.prototype [ %Symbol.toStringTag% ]

The initial value of the %Symbol.toStringTag% property is the String value "Promise".

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: true }.

27.2.6 Properties of Promise Instances

Promise instances are ordinary objects that inherit properties from the Promise prototype object (the intrinsic, %Promise.prototype%). Promise instances are initially created with the internal slots described in Table 92.

Table 92: Internal Slots of Promise Instances
Internal Slot Type Description
[[PromiseState]] pending, fulfilled, or rejected Governs how a promise will react to incoming calls to its then method.
[[PromiseResult]] an ECMAScript language value or empty The value with which the promise has been fulfilled or rejected, if any. empty if and only if the [[PromiseState]] is pending.
[[PromiseFulfillReactions]] a List of PromiseReaction Records Records to be processed when/if the promise transitions from the pending state to the fulfilled state.
[[PromiseRejectReactions]] a List of PromiseReaction Records Records to be processed when/if the promise transitions from the pending state to the rejected state.
[[PromiseIsHandled]] a Boolean Indicates whether the promise has ever had a fulfillment or rejection handler; used in unhandled rejection tracking.

27.3 GeneratorFunction Objects

GeneratorFunctions are functions that are usually created by evaluating GeneratorDeclarations, GeneratorExpressions, and GeneratorMethods. They may also be created by calling the %GeneratorFunction% intrinsic.

Figure 6 (Informative): Generator Objects Relationships
A staggering variety of boxes and arrows.

27.3.1 The GeneratorFunction Constructor

The GeneratorFunction constructor:

  • is %GeneratorFunction%.
  • is a subclass of Function.
  • creates and initializes a new GeneratorFunction when called as a function rather than as a constructor. Thus the function call GeneratorFunction (…) is equivalent to the object creation expression new GeneratorFunction (…) with the same arguments.
  • may be used as the value of an extends clause of a class definition. Subclass constructors that intend to inherit the specified GeneratorFunction behaviour must include a super call to the GeneratorFunction constructor to create and initialize subclass instances with the internal slots necessary for built-in GeneratorFunction behaviour. All ECMAScript syntactic forms for defining generator function objects create direct instances of GeneratorFunction. There is no syntactic means to create instances of GeneratorFunction subclasses.

27.3.1.1 GeneratorFunction ( ...parameterArgs, bodyArg )

The last argument (if any) specifies the body (executable code) of a generator function; any preceding arguments specify formal parameters.

This function performs the following steps when called:

  1. Let C be the active function object.
  2. If bodyArg is not present, set bodyArg to the empty String.
  3. Return ? CreateDynamicFunction(C, NewTarget, generator, parameterArgs, bodyArg).
Note

See NOTE for 20.2.1.1.

27.3.2 Properties of the GeneratorFunction Constructor

The GeneratorFunction constructor:

  • is a standard built-in function object that inherits from the Function constructor.
  • has a [[Prototype]] internal slot whose value is %Function%.
  • has a "length" property whose value is 1𝔽.
  • has a "name" property whose value is "GeneratorFunction".
  • has the following properties:

27.3.2.1 GeneratorFunction.prototype

The initial value of GeneratorFunction.prototype is the GeneratorFunction prototype object.

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: false }.

27.3.3 Properties of the GeneratorFunction Prototype Object

The GeneratorFunction prototype object:

27.3.3.1 GeneratorFunction.prototype.constructor

The initial value of GeneratorFunction.prototype.constructor is %GeneratorFunction%.

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: true }.

27.3.3.2 GeneratorFunction.prototype.prototype

The initial value of GeneratorFunction.prototype.prototype is %GeneratorPrototype%.

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: true }.

27.3.3.3 GeneratorFunction.prototype [ %Symbol.toStringTag% ]

The initial value of the %Symbol.toStringTag% property is the String value "GeneratorFunction".

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: true }.

27.3.4 GeneratorFunction Instances

Every GeneratorFunction instance is an ECMAScript function object and has the internal slots listed in Table 30. The value of the [[IsClassConstructor]] internal slot for all such instances is false.

Each GeneratorFunction instance has the following own properties:

27.3.4.1 length

The specification for the "length" property of Function instances given in 20.2.4.1 also applies to GeneratorFunction instances.

27.3.4.2 name

The specification for the "name" property of Function instances given in 20.2.4.2 also applies to GeneratorFunction instances.

27.3.4.3 prototype

Whenever a GeneratorFunction instance is created another ordinary object is also created and is the initial value of the generator function's "prototype" property. The value of the prototype property is used to initialize the [[Prototype]] internal slot of a newly created Generator when the generator function object is invoked using [[Call]].

This property has the attributes { [[Writable]]: true, [[Enumerable]]: false, [[Configurable]]: false }.

Note

Unlike Function instances, the object that is the value of a GeneratorFunction's "prototype" property does not have a "constructor" property whose value is the GeneratorFunction instance.

27.4 AsyncGeneratorFunction Objects

AsyncGeneratorFunctions are functions that are usually created by evaluating AsyncGeneratorDeclaration, AsyncGeneratorExpression, and AsyncGeneratorMethod syntactic productions. They may also be created by calling the %AsyncGeneratorFunction% intrinsic.

27.4.1 The AsyncGeneratorFunction Constructor

The AsyncGeneratorFunction constructor:

  • is %AsyncGeneratorFunction%.
  • is a subclass of Function.
  • creates and initializes a new AsyncGeneratorFunction when called as a function rather than as a constructor. Thus the function call AsyncGeneratorFunction (...) is equivalent to the object creation expression new AsyncGeneratorFunction (...) with the same arguments.
  • may be used as the value of an extends clause of a class definition. Subclass constructors that intend to inherit the specified AsyncGeneratorFunction behaviour must include a super call to the AsyncGeneratorFunction constructor to create and initialize subclass instances with the internal slots necessary for built-in AsyncGeneratorFunction behaviour. All ECMAScript syntactic forms for defining async generator function objects create direct instances of AsyncGeneratorFunction. There is no syntactic means to create instances of AsyncGeneratorFunction subclasses.

27.4.1.1 AsyncGeneratorFunction ( ...parameterArgs, bodyArg )

The last argument (if any) specifies the body (executable code) of an async generator function; any preceding arguments specify formal parameters.

This function performs the following steps when called:

  1. Let C be the active function object.
  2. If bodyArg is not present, set bodyArg to the empty String.
  3. Return ? CreateDynamicFunction(C, NewTarget, async-generator, parameterArgs, bodyArg).
Note

See NOTE for 20.2.1.1.

27.4.2 Properties of the AsyncGeneratorFunction Constructor

The AsyncGeneratorFunction constructor:

  • is a standard built-in function object that inherits from the Function constructor.
  • has a [[Prototype]] internal slot whose value is %Function%.
  • has a "length" property whose value is 1𝔽.
  • has a "name" property whose value is "AsyncGeneratorFunction".
  • has the following properties:

27.4.2.1 AsyncGeneratorFunction.prototype

The initial value of AsyncGeneratorFunction.prototype is the AsyncGeneratorFunction prototype object.

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: false }.

27.4.3 Properties of the AsyncGeneratorFunction Prototype Object

The AsyncGeneratorFunction prototype object:

27.4.3.1 AsyncGeneratorFunction.prototype.constructor

The initial value of AsyncGeneratorFunction.prototype.constructor is %AsyncGeneratorFunction%.

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: true }.

27.4.3.2 AsyncGeneratorFunction.prototype.prototype

The initial value of AsyncGeneratorFunction.prototype.prototype is %AsyncGeneratorPrototype%.

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: true }.

27.4.3.3 AsyncGeneratorFunction.prototype [ %Symbol.toStringTag% ]

The initial value of the %Symbol.toStringTag% property is the String value "AsyncGeneratorFunction".

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: true }.

27.4.4 AsyncGeneratorFunction Instances

Every AsyncGeneratorFunction instance is an ECMAScript function object and has the internal slots listed in Table 30. The value of the [[IsClassConstructor]] internal slot for all such instances is false.

Each AsyncGeneratorFunction instance has the following own properties:

27.4.4.1 length

The value of the "length" property is an integral Number that indicates the typical number of arguments expected by the AsyncGeneratorFunction. However, the language permits the function to be invoked with some other number of arguments. The behaviour of an AsyncGeneratorFunction when invoked on a number of arguments other than the number specified by its "length" property depends on the function.

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: true }.

27.4.4.2 name

The specification for the "name" property of Function instances given in 20.2.4.2 also applies to AsyncGeneratorFunction instances.

27.4.4.3 prototype

Whenever an AsyncGeneratorFunction instance is created, another ordinary object is also created and is the initial value of the async generator function's "prototype" property. The value of the prototype property is used to initialize the [[Prototype]] internal slot of a newly created AsyncGenerator when the generator function object is invoked using [[Call]].

This property has the attributes { [[Writable]]: true, [[Enumerable]]: false, [[Configurable]]: false }.

Note

Unlike function instances, the object that is the value of an AsyncGeneratorFunction's "prototype" property does not have a "constructor" property whose value is the AsyncGeneratorFunction instance.

27.5 Generator Objects

A Generator is created by calling a generator function and conforms to both the iterator interface and the iterable interface.

Generator instances directly inherit properties from the initial value of the "prototype" property of the generator function that created the instance. Generator instances indirectly inherit properties from %GeneratorPrototype%.

27.5.1 The %GeneratorPrototype% Object

The %GeneratorPrototype% object:

  • is %GeneratorFunction.prototype.prototype%.
  • is an ordinary object.
  • is not a Generator instance and does not have a [[GeneratorState]] internal slot.
  • has a [[Prototype]] internal slot whose value is %Iterator.prototype%.
  • has properties that are indirectly inherited by all Generator instances.

27.5.1.1 %GeneratorPrototype%.constructor

The initial value of %GeneratorPrototype%.constructor is %GeneratorFunction.prototype%.

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: true }.

27.5.1.2 %GeneratorPrototype%.next ( value )

  1. Return ? GeneratorResume(this value, value, empty).

27.5.1.3 %GeneratorPrototype%.return ( value )

This method performs the following steps when called:

  1. Let g be the this value.
  2. Let C be ReturnCompletion(value).
  3. Return ? GeneratorResumeAbrupt(g, C, empty).

27.5.1.4 %GeneratorPrototype%.throw ( exception )

This method performs the following steps when called:

  1. Let g be the this value.
  2. Let C be ThrowCompletion(exception).
  3. Return ? GeneratorResumeAbrupt(g, C, empty).

27.5.1.5 %GeneratorPrototype% [ %Symbol.toStringTag% ]

The initial value of the %Symbol.toStringTag% property is the String value "Generator".

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: true }.

27.5.2 Properties of Generator Instances

Generator instances are initially created with the internal slots described in Table 93.

Table 93: Internal Slots of Generator Instances
Internal Slot Type Description
[[GeneratorState]] suspended-start, suspended-yield, executing, or completed The current execution state of the generator.
[[GeneratorContext]] an execution context The execution context that is used when executing the code of this generator.
[[GeneratorBrand]] a String or empty A brand used to distinguish different kinds of generators. The [[GeneratorBrand]] of generators declared by ECMAScript source text is always empty.

27.5.3 Generator Abstract Operations

27.5.3.1 GeneratorStart ( generator, generatorBody )

The abstract operation GeneratorStart takes arguments generator (a Generator) and generatorBody (a FunctionBody Parse Node or an Abstract Closure with no parameters) and returns unused. It performs the following steps when called:

  1. Assert: generator.[[GeneratorState]] is suspended-start.
  2. Let genContext be the running execution context.
  3. Set the Generator component of genContext to generator.
  4. Let closure be a new Abstract Closure with no parameters that captures generatorBody and performs the following steps when called:
    1. Let acGenContext be the running execution context.
    2. Let acGenerator be the Generator component of acGenContext.
    3. If generatorBody is a Parse Node, then
      1. Let result be Completion(Evaluation of generatorBody).
    4. Else,
      1. Assert: generatorBody is an Abstract Closure with no parameters.
      2. Let result be Completion(generatorBody()).
    5. Assert: If we return here, the generator either threw an exception or performed either an implicit or explicit return.
    6. Remove acGenContext from the execution context stack and restore the execution context that is at the top of the execution context stack as the running execution context.
    7. Set acGenerator.[[GeneratorState]] to completed.
    8. NOTE: Once a generator enters the completed state it never leaves it and its associated execution context is never resumed. Any execution state associated with acGenerator can be discarded at this point.
    9. If result is a normal completion, then
      1. Let resultValue be undefined.
    10. Else if result is a return completion, then
      1. Let resultValue be result.[[Value]].
    11. Else,
      1. Assert: result is a throw completion.
      2. Return ? result.
    12. Return NormalCompletion(CreateIteratorResultObject(resultValue, true)).
  5. Set the code evaluation state of genContext such that when evaluation is resumed for that execution context, closure will be called with no arguments.
  6. Set generator.[[GeneratorContext]] to genContext.
  7. Return unused.

27.5.3.2 GeneratorValidate ( generator, generatorBrand )

The abstract operation GeneratorValidate takes arguments generator (an ECMAScript language value) and generatorBrand (a String or empty) and returns either a normal completion containing one of suspended-start, suspended-yield, or completed, or a throw completion. It performs the following steps when called:

  1. Perform ? RequireInternalSlot(generator, [[GeneratorState]]).
  2. Perform ? RequireInternalSlot(generator, [[GeneratorBrand]]).
  3. If generator.[[GeneratorBrand]] is not generatorBrand, throw a TypeError exception.
  4. Assert: generator also has a [[GeneratorContext]] internal slot.
  5. Let state be generator.[[GeneratorState]].
  6. If state is executing, throw a TypeError exception.
  7. Return state.

27.5.3.3 GeneratorResume ( generator, value, generatorBrand )

The abstract operation GeneratorResume takes arguments generator (an ECMAScript language value), value (an ECMAScript language value or empty), and generatorBrand (a String or empty) and returns either a normal completion containing an ECMAScript language value or a throw completion. It performs the following steps when called:

  1. Let state be ? GeneratorValidate(generator, generatorBrand).
  2. If state is completed, return CreateIteratorResultObject(undefined, true).
  3. Assert: state is either suspended-start or suspended-yield.
  4. Let genContext be generator.[[GeneratorContext]].
  5. Let methodContext be the running execution context.
  6. Suspend methodContext.
  7. Set generator.[[GeneratorState]] to executing.
  8. Push genContext onto the execution context stack; genContext is now the running execution context.
  9. Resume the suspended evaluation of genContext using NormalCompletion(value) as the result of the operation that suspended it. Let result be the value returned by the resumed computation.
  10. Assert: When we return here, genContext has already been removed from the execution context stack and methodContext is the currently running execution context.
  11. Return ? result.

27.5.3.4 GeneratorResumeAbrupt ( generator, abruptCompletion, generatorBrand )

The abstract operation GeneratorResumeAbrupt takes arguments generator (an ECMAScript language value), abruptCompletion (a return completion or a throw completion), and generatorBrand (a String or empty) and returns either a normal completion containing an ECMAScript language value or a throw completion. It performs the following steps when called:

  1. Let state be ? GeneratorValidate(generator, generatorBrand).
  2. If state is suspended-start, then
    1. Set generator.[[GeneratorState]] to completed.
    2. NOTE: Once a generator enters the completed state it never leaves it and its associated execution context is never resumed. Any execution state associated with generator can be discarded at this point.
    3. Set state to completed.
  3. If state is completed, then
    1. If abruptCompletion is a return completion, then
      1. Return CreateIteratorResultObject(abruptCompletion.[[Value]], true).
    2. Return ? abruptCompletion.
  4. Assert: state is suspended-yield.
  5. Let genContext be generator.[[GeneratorContext]].
  6. Let methodContext be the running execution context.
  7. Suspend methodContext.
  8. Set generator.[[GeneratorState]] to executing.
  9. Push genContext onto the execution context stack; genContext is now the running execution context.
  10. Resume the suspended evaluation of genContext using abruptCompletion as the result of the operation that suspended it. Let result be the Completion Record returned by the resumed computation.
  11. Assert: When we return here, genContext has already been removed from the execution context stack and methodContext is the currently running execution context.
  12. Return ? result.

27.5.3.5 GetGeneratorKind ( )

The abstract operation GetGeneratorKind takes no arguments and returns non-generator, sync, or async. It performs the following steps when called:

  1. Let genContext be the running execution context.
  2. If genContext does not have a Generator component, return non-generator.
  3. Let generator be the Generator component of genContext.
  4. If generator has an [[AsyncGeneratorState]] internal slot, return async.
  5. Else, return sync.

27.5.3.6 GeneratorYield ( iteratorResult )

The abstract operation GeneratorYield takes argument iteratorResult (an Object that conforms to the IteratorResult interface) and returns either a normal completion containing an ECMAScript language value or an abrupt completion. It performs the following steps when called:

  1. Let genContext be the running execution context.
  2. Assert: genContext is the execution context of a generator.
  3. Let generator be the value of the Generator component of genContext.
  4. Assert: GetGeneratorKind() is sync.
  5. Set generator.[[GeneratorState]] to suspended-yield.
  6. Remove genContext from the execution context stack and restore the execution context that is at the top of the execution context stack as the running execution context.
  7. Let callerContext be the running execution context.
  8. Resume callerContext passing NormalCompletion(iteratorResult). If genContext is ever resumed again, let resumptionValue be the Completion Record with which it is resumed.
  9. Assert: If control reaches here, then genContext is the running execution context again.
  10. Return resumptionValue.

27.5.3.7 Yield ( value )

The abstract operation Yield takes argument value (an ECMAScript language value) and returns either a normal completion containing an ECMAScript language value or an abrupt completion. It performs the following steps when called:

  1. Let generatorKind be GetGeneratorKind().
  2. If generatorKind is async, return ? AsyncGeneratorYield(? Await(value)).
  3. Otherwise, return ? GeneratorYield(CreateIteratorResultObject(value, false)).

27.5.3.8 CreateIteratorFromClosure ( closure, generatorBrand, generatorPrototype [ , extraSlots ] )

The abstract operation CreateIteratorFromClosure takes arguments closure (an Abstract Closure with no parameters), generatorBrand (a String or empty), and generatorPrototype (an Object) and optional argument extraSlots (a List of names of internal slots) and returns a Generator. It performs the following steps when called:

  1. NOTE: closure can contain uses of the Yield operation to yield an IteratorResult object.
  2. If extraSlots is not present, set extraSlots to a new empty List.
  3. Let internalSlotsList be the list-concatenation of extraSlots and « [[GeneratorState]], [[GeneratorContext]], [[GeneratorBrand]] ».
  4. Let generator be OrdinaryObjectCreate(generatorPrototype, internalSlotsList).
  5. Set generator.[[GeneratorBrand]] to generatorBrand.
  6. Set generator.[[GeneratorState]] to suspended-start.
  7. Let callerContext be the running execution context.
  8. Let calleeContext be a new execution context.
  9. Set the Function of calleeContext to null.
  10. Set the Realm of calleeContext to the current Realm Record.
  11. Set the ScriptOrModule of calleeContext to callerContext's ScriptOrModule.
  12. If callerContext is not already suspended, suspend callerContext.
  13. Push calleeContext onto the execution context stack; calleeContext is now the running execution context.
  14. Perform GeneratorStart(generator, closure).
  15. Remove calleeContext from the execution context stack and restore callerContext as the running execution context.
  16. Return generator.

27.6 AsyncGenerator Objects

An AsyncGenerator is created by calling an async generator function and conforms to both the async iterator interface and the async iterable interface.

AsyncGenerator instances directly inherit properties from the initial value of the "prototype" property of the async generator function that created the instance. AsyncGenerator instances indirectly inherit properties from %AsyncGeneratorPrototype%.

27.6.1 The %AsyncGeneratorPrototype% Object

The %AsyncGeneratorPrototype% object:

  • is %AsyncGeneratorFunction.prototype.prototype%.
  • is an ordinary object.
  • is not an AsyncGenerator instance and does not have an [[AsyncGeneratorState]] internal slot.
  • has a [[Prototype]] internal slot whose value is %AsyncIteratorPrototype%.
  • has properties that are indirectly inherited by all AsyncGenerator instances.

27.6.1.1 %AsyncGeneratorPrototype%.constructor

The initial value of %AsyncGeneratorPrototype%.constructor is %AsyncGeneratorFunction.prototype%.

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: true }.

27.6.1.2 %AsyncGeneratorPrototype%.next ( value )

  1. Let generator be the this value.
  2. Let promiseCapability be ! NewPromiseCapability(%Promise%).
  3. Let result be Completion(AsyncGeneratorValidate(generator, empty)).
  4. IfAbruptRejectPromise(result, promiseCapability).
  5. Let state be generator.[[AsyncGeneratorState]].
  6. If state is completed, then
    1. Let iteratorResult be CreateIteratorResultObject(undefined, true).
    2. Perform ! Call(promiseCapability.[[Resolve]], undefined, « iteratorResult »).
    3. Return promiseCapability.[[Promise]].
  7. Let completion be NormalCompletion(value).
  8. Perform AsyncGeneratorEnqueue(generator, completion, promiseCapability).
  9. If state is either suspended-start or suspended-yield, then
    1. Perform AsyncGeneratorResume(generator, completion).
  10. Else,
    1. Assert: state is either executing or draining-queue.
  11. Return promiseCapability.[[Promise]].

27.6.1.3 %AsyncGeneratorPrototype%.return ( value )

  1. Let generator be the this value.
  2. Let promiseCapability be ! NewPromiseCapability(%Promise%).
  3. Let result be Completion(AsyncGeneratorValidate(generator, empty)).
  4. IfAbruptRejectPromise(result, promiseCapability).
  5. Let completion be ReturnCompletion(value).
  6. Perform AsyncGeneratorEnqueue(generator, completion, promiseCapability).
  7. Let state be generator.[[AsyncGeneratorState]].
  8. If state is either suspended-start or completed, then
    1. Set generator.[[AsyncGeneratorState]] to draining-queue.
    2. Perform AsyncGeneratorAwaitReturn(generator).
  9. Else if state is suspended-yield, then
    1. Perform AsyncGeneratorResume(generator, completion).
  10. Else,
    1. Assert: state is either executing or draining-queue.
  11. Return promiseCapability.[[Promise]].

27.6.1.4 %AsyncGeneratorPrototype%.throw ( exception )

  1. Let generator be the this value.
  2. Let promiseCapability be ! NewPromiseCapability(%Promise%).
  3. Let result be Completion(AsyncGeneratorValidate(generator, empty)).
  4. IfAbruptRejectPromise(result, promiseCapability).
  5. Let state be generator.[[AsyncGeneratorState]].
  6. If state is suspended-start, then
    1. Set generator.[[AsyncGeneratorState]] to completed.
    2. Set state to completed.
  7. If state is completed, then
    1. Perform ! Call(promiseCapability.[[Reject]], undefined, « exception »).
    2. Return promiseCapability.[[Promise]].
  8. Let completion be ThrowCompletion(exception).
  9. Perform AsyncGeneratorEnqueue(generator, completion, promiseCapability).
  10. If state is suspended-yield, then
    1. Perform AsyncGeneratorResume(generator, completion).
  11. Else,
    1. Assert: state is either executing or draining-queue.
  12. Return promiseCapability.[[Promise]].

27.6.1.5 %AsyncGeneratorPrototype% [ %Symbol.toStringTag% ]

The initial value of the %Symbol.toStringTag% property is the String value "AsyncGenerator".

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: true }.

27.6.2 Properties of AsyncGenerator Instances

AsyncGenerator instances are initially created with the internal slots described below:

Table 94: Internal Slots of AsyncGenerator Instances
Internal Slot Type Description
[[AsyncGeneratorState]] suspended-start, suspended-yield, executing, draining-queue, or completed The current execution state of the async generator.
[[AsyncGeneratorContext]] an execution context The execution context that is used when executing the code of this async generator.
[[AsyncGeneratorQueue]] a List of AsyncGeneratorRequest Records Records which represent requests to resume the async generator. Except during state transitions, it is non-empty if and only if [[AsyncGeneratorState]] is either executing or draining-queue.
[[GeneratorBrand]] a String or empty A brand used to distinguish different kinds of async generators. The [[GeneratorBrand]] of async generators declared by ECMAScript source text is always empty.

27.6.3 AsyncGenerator Abstract Operations

27.6.3.1 AsyncGeneratorRequest Records

An AsyncGeneratorRequest is a Record value used to store information about how an async generator should be resumed and contains capabilities for fulfilling or rejecting the corresponding promise.

They have the following fields:

Table 95: AsyncGeneratorRequest Record Fields
Field Name Value Meaning
[[Completion]] a Completion Record The Completion Record which should be used to resume the async generator.
[[Capability]] a PromiseCapability Record The promise capabilities associated with this request.

27.6.3.2 AsyncGeneratorStart ( generator, generatorBody )

The abstract operation AsyncGeneratorStart takes arguments generator (an AsyncGenerator) and generatorBody (a FunctionBody Parse Node or an Abstract Closure with no parameters) and returns unused. It performs the following steps when called:

  1. Assert: generator.[[AsyncGeneratorState]] is suspended-start.
  2. Let genContext be the running execution context.
  3. Set the Generator component of genContext to generator.
  4. Let closure be a new Abstract Closure with no parameters that captures generatorBody and performs the following steps when called:
    1. Let acGenContext be the running execution context.
    2. Let acGenerator be the Generator component of acGenContext.
    3. If generatorBody is a Parse Node, then
      1. Let result be Completion(Evaluation of generatorBody).
    4. Else,
      1. Assert: generatorBody is an Abstract Closure with no parameters.
      2. Let result be Completion(generatorBody()).
    5. Assert: If we return here, the async generator either threw an exception or performed either an implicit or explicit return.
    6. Remove acGenContext from the execution context stack and restore the execution context that is at the top of the execution context stack as the running execution context.
    7. Set acGenerator.[[AsyncGeneratorState]] to draining-queue.
    8. If result is a normal completion, set result to NormalCompletion(undefined).
    9. If result is a return completion, set result to NormalCompletion(result.[[Value]]).
    10. Perform AsyncGeneratorCompleteStep(acGenerator, result, true).
    11. Perform AsyncGeneratorDrainQueue(acGenerator).
    12. Return NormalCompletion(undefined).
  5. Set the code evaluation state of genContext such that when evaluation is resumed for that execution context, closure will be called with no arguments.
  6. Set generator.[[AsyncGeneratorContext]] to genContext.
  7. Set generator.[[AsyncGeneratorQueue]] to a new empty List.
  8. Return unused.

27.6.3.3 AsyncGeneratorValidate ( generator, generatorBrand )

The abstract operation AsyncGeneratorValidate takes arguments generator (an ECMAScript language value) and generatorBrand (a String or empty) and returns either a normal completion containing unused or a throw completion. It performs the following steps when called:

  1. Perform ? RequireInternalSlot(generator, [[AsyncGeneratorContext]]).
  2. Perform ? RequireInternalSlot(generator, [[AsyncGeneratorState]]).
  3. Perform ? RequireInternalSlot(generator, [[AsyncGeneratorQueue]]).
  4. If generator.[[GeneratorBrand]] is not generatorBrand, throw a TypeError exception.
  5. Return unused.

27.6.3.4 AsyncGeneratorEnqueue ( generator, completion, promiseCapability )

The abstract operation AsyncGeneratorEnqueue takes arguments generator (an AsyncGenerator), completion (a Completion Record), and promiseCapability (a PromiseCapability Record) and returns unused. It performs the following steps when called:

  1. Let request be AsyncGeneratorRequest { [[Completion]]: completion, [[Capability]]: promiseCapability }.
  2. Append request to generator.[[AsyncGeneratorQueue]].
  3. Return unused.

27.6.3.5 AsyncGeneratorCompleteStep ( generator, completion, done [ , realm ] )

The abstract operation AsyncGeneratorCompleteStep takes arguments generator (an AsyncGenerator), completion (a Completion Record), and done (a Boolean) and optional argument realm (a Realm Record) and returns unused. It performs the following steps when called:

  1. Assert: generator.[[AsyncGeneratorQueue]] is not empty.
  2. Let next be the first element of generator.[[AsyncGeneratorQueue]].
  3. Remove the first element from generator.[[AsyncGeneratorQueue]].
  4. Let promiseCapability be next.[[Capability]].
  5. Let value be completion.[[Value]].
  6. If completion is a throw completion, then
    1. Perform ! Call(promiseCapability.[[Reject]], undefined, « value »).
  7. Else,
    1. Assert: completion is a normal completion.
    2. If realm is present, then
      1. Let oldRealm be the running execution context's Realm.
      2. Set the running execution context's Realm to realm.
      3. Let iteratorResult be CreateIteratorResultObject(value, done).
      4. Set the running execution context's Realm to oldRealm.
    3. Else,
      1. Let iteratorResult be CreateIteratorResultObject(value, done).
    4. Perform ! Call(promiseCapability.[[Resolve]], undefined, « iteratorResult »).
  8. Return unused.

27.6.3.6 AsyncGeneratorResume ( generator, completion )

The abstract operation AsyncGeneratorResume takes arguments generator (an AsyncGenerator) and completion (a Completion Record) and returns unused. It performs the following steps when called:

  1. Assert: generator.[[AsyncGeneratorState]] is either suspended-start or suspended-yield.
  2. Let genContext be generator.[[AsyncGeneratorContext]].
  3. Let callerContext be the running execution context.
  4. Suspend callerContext.
  5. Set generator.[[AsyncGeneratorState]] to executing.
  6. Push genContext onto the execution context stack; genContext is now the running execution context.
  7. Resume the suspended evaluation of genContext using completion as the result of the operation that suspended it. Let result be the Completion Record returned by the resumed computation.
  8. Assert: result is never an abrupt completion.
  9. Assert: When we return here, genContext has already been removed from the execution context stack and callerContext is the currently running execution context.
  10. Return unused.

27.6.3.7 AsyncGeneratorUnwrapYieldResumption ( resumptionValue )

The abstract operation AsyncGeneratorUnwrapYieldResumption takes argument resumptionValue (a Completion Record) and returns either a normal completion containing an ECMAScript language value or an abrupt completion. It performs the following steps when called:

  1. If resumptionValue is not a return completion, return ? resumptionValue.
  2. Let awaited be Completion(Await(resumptionValue.[[Value]])).
  3. If awaited is a throw completion, return ? awaited.
  4. Assert: awaited is a normal completion.
  5. Return ReturnCompletion(awaited.[[Value]]).

27.6.3.8 AsyncGeneratorYield ( value )

The abstract operation AsyncGeneratorYield takes argument value (an ECMAScript language value) and returns either a normal completion containing an ECMAScript language value or an abrupt completion. It performs the following steps when called:

  1. Let genContext be the running execution context.
  2. Assert: genContext is the execution context of a generator.
  3. Let generator be the value of the Generator component of genContext.
  4. Assert: GetGeneratorKind() is async.
  5. Let completion be NormalCompletion(value).
  6. Assert: The execution context stack has at least two elements.
  7. Let previousContext be the second to top element of the execution context stack.
  8. Let previousRealm be previousContext's Realm.
  9. Perform AsyncGeneratorCompleteStep(generator, completion, false, previousRealm).
  10. Let queue be generator.[[AsyncGeneratorQueue]].
  11. If queue is not empty, then
    1. NOTE: Execution continues without suspending the generator.
    2. Let toYield be the first element of queue.
    3. Let resumptionValue be Completion(toYield.[[Completion]]).
    4. Return ? AsyncGeneratorUnwrapYieldResumption(resumptionValue).
  12. Else,
    1. Set generator.[[AsyncGeneratorState]] to suspended-yield.
    2. Remove genContext from the execution context stack and restore the execution context that is at the top of the execution context stack as the running execution context.
    3. Let callerContext be the running execution context.
    4. Resume callerContext passing undefined. If genContext is ever resumed again, let resumptionValue be the Completion Record with which it is resumed.
    5. Assert: If control reaches here, then genContext is the running execution context again.
    6. Return ? AsyncGeneratorUnwrapYieldResumption(resumptionValue).

27.6.3.9 AsyncGeneratorAwaitReturn ( generator )

The abstract operation AsyncGeneratorAwaitReturn takes argument generator (an AsyncGenerator) and returns unused. It performs the following steps when called:

  1. Assert: generator.[[AsyncGeneratorState]] is draining-queue.
  2. Let queue be generator.[[AsyncGeneratorQueue]].
  3. Assert: queue is not empty.
  4. Let next be the first element of queue.
  5. Let completion be Completion(next.[[Completion]]).
  6. Assert: completion is a return completion.
  7. Let promiseCompletion be Completion(PromiseResolve(%Promise%, completion.[[Value]])).
  8. If promiseCompletion is an abrupt completion, then
    1. Perform AsyncGeneratorCompleteStep(generator, promiseCompletion, true).
    2. Perform AsyncGeneratorDrainQueue(generator).
    3. Return unused.
  9. Assert: promiseCompletion is a normal completion.
  10. Let promise be promiseCompletion.[[Value]].
  11. Let fulfilledClosure be a new Abstract Closure with parameters (value) that captures generator and performs the following steps when called:
    1. Assert: generator.[[AsyncGeneratorState]] is draining-queue.
    2. Let result be NormalCompletion(value).
    3. Perform AsyncGeneratorCompleteStep(generator, result, true).
    4. Perform AsyncGeneratorDrainQueue(generator).
    5. Return NormalCompletion(undefined).
  12. Let onFulfilled be CreateBuiltinFunction(fulfilledClosure, 1, "", « »).
  13. Let rejectedClosure be a new Abstract Closure with parameters (reason) that captures generator and performs the following steps when called:
    1. Assert: generator.[[AsyncGeneratorState]] is draining-queue.
    2. Let result be ThrowCompletion(reason).
    3. Perform AsyncGeneratorCompleteStep(generator, result, true).
    4. Perform AsyncGeneratorDrainQueue(generator).
    5. Return NormalCompletion(undefined).
  14. Let onRejected be CreateBuiltinFunction(rejectedClosure, 1, "", « »).
  15. Perform PerformPromiseThen(promise, onFulfilled, onRejected).
  16. Return unused.

27.6.3.10 AsyncGeneratorDrainQueue ( generator )

The abstract operation AsyncGeneratorDrainQueue takes argument generator (an AsyncGenerator) and returns unused. It drains the generator's AsyncGeneratorQueue until it encounters an AsyncGeneratorRequest which holds a return completion. It performs the following steps when called:

  1. Assert: generator.[[AsyncGeneratorState]] is draining-queue.
  2. Let queue be generator.[[AsyncGeneratorQueue]].
  3. Repeat, while queue is not empty,
    1. Let next be the first element of queue.
    2. Let completion be Completion(next.[[Completion]]).
    3. If completion is a return completion, then
      1. Perform AsyncGeneratorAwaitReturn(generator).
      2. Return unused.
    4. Else,
      1. If completion is a normal completion, then
        1. Set completion to NormalCompletion(undefined).
      2. Perform AsyncGeneratorCompleteStep(generator, completion, true).
  4. Set generator.[[AsyncGeneratorState]] to completed.
  5. Return unused.

27.6.3.11 CreateAsyncIteratorFromClosure ( closure, generatorBrand, generatorPrototype )

The abstract operation CreateAsyncIteratorFromClosure takes arguments closure (an Abstract Closure with no parameters), generatorBrand (a String or empty), and generatorPrototype (an Object) and returns an AsyncGenerator. It performs the following steps when called:

  1. NOTE: closure can contain uses of the Await operation and uses of the Yield operation to yield an IteratorResult object.
  2. Let internalSlotsList be « [[AsyncGeneratorState]], [[AsyncGeneratorContext]], [[AsyncGeneratorQueue]], [[GeneratorBrand]] ».
  3. Let generator be OrdinaryObjectCreate(generatorPrototype, internalSlotsList).
  4. Set generator.[[GeneratorBrand]] to generatorBrand.
  5. Set generator.[[AsyncGeneratorState]] to suspended-start.
  6. Let callerContext be the running execution context.
  7. Let calleeContext be a new execution context.
  8. Set the Function of calleeContext to null.
  9. Set the Realm of calleeContext to the current Realm Record.
  10. Set the ScriptOrModule of calleeContext to callerContext's ScriptOrModule.
  11. If callerContext is not already suspended, suspend callerContext.
  12. Push calleeContext onto the execution context stack; calleeContext is now the running execution context.
  13. Perform AsyncGeneratorStart(generator, closure).
  14. Remove calleeContext from the execution context stack and restore callerContext as the running execution context.
  15. Return generator.

27.7 AsyncFunction Objects

AsyncFunctions are functions that are usually created by evaluating AsyncFunctionDeclarations, AsyncFunctionExpressions, AsyncMethods, and AsyncArrowFunctions. They may also be created by calling the %AsyncFunction% intrinsic.

27.7.1 The AsyncFunction Constructor

The AsyncFunction constructor:

  • is %AsyncFunction%.
  • is a subclass of Function.
  • creates and initializes a new AsyncFunction when called as a function rather than as a constructor. Thus the function call AsyncFunction(…) is equivalent to the object creation expression new AsyncFunction(…) with the same arguments.
  • may be used as the value of an extends clause of a class definition. Subclass constructors that intend to inherit the specified AsyncFunction behaviour must include a super call to the AsyncFunction constructor to create and initialize a subclass instance with the internal slots necessary for built-in async function behaviour. All ECMAScript syntactic forms for defining async function objects create direct instances of AsyncFunction. There is no syntactic means to create instances of AsyncFunction subclasses.

27.7.1.1 AsyncFunction ( ...parameterArgs, bodyArg )

The last argument (if any) specifies the body (executable code) of an async function. Any preceding arguments specify formal parameters.

This function performs the following steps when called:

  1. Let C be the active function object.
  2. If bodyArg is not present, set bodyArg to the empty String.
  3. Return ? CreateDynamicFunction(C, NewTarget, async, parameterArgs, bodyArg).
Note
See NOTE for 20.2.1.1.

27.7.2 Properties of the AsyncFunction Constructor

The AsyncFunction constructor:

  • is a standard built-in function object that inherits from the Function constructor.
  • has a [[Prototype]] internal slot whose value is %Function%.
  • has a "length" property whose value is 1𝔽.
  • has a "name" property whose value is "AsyncFunction".
  • has the following properties:

27.7.2.1 AsyncFunction.prototype

The initial value of AsyncFunction.prototype is the AsyncFunction prototype object.

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: false }.

27.7.3 Properties of the AsyncFunction Prototype Object

The AsyncFunction prototype object:

27.7.3.1 AsyncFunction.prototype.constructor

The initial value of AsyncFunction.prototype.constructor is %AsyncFunction%.

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: true }.

27.7.3.2 AsyncFunction.prototype [ %Symbol.toStringTag% ]

The initial value of the %Symbol.toStringTag% property is the String value "AsyncFunction".

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: true }.

27.7.4 AsyncFunction Instances

Every AsyncFunction instance is an ECMAScript function object and has the internal slots listed in Table 30. The value of the [[IsClassConstructor]] internal slot for all such instances is false. AsyncFunction instances are not constructors and do not have a [[Construct]] internal method. AsyncFunction instances do not have a prototype property as they are not constructable.

Each AsyncFunction instance has the following own properties:

27.7.4.1 length

The specification for the "length" property of Function instances given in 20.2.4.1 also applies to AsyncFunction instances.

27.7.4.2 name

The specification for the "name" property of Function instances given in 20.2.4.2 also applies to AsyncFunction instances.

27.7.5 Async Functions Abstract Operations

27.7.5.1 AsyncFunctionStart ( promiseCapability, asyncFunctionBody )

The abstract operation AsyncFunctionStart takes arguments promiseCapability (a PromiseCapability Record) and asyncFunctionBody (a FunctionBody Parse Node, an ExpressionBody Parse Node, or an Abstract Closure with no parameters) and returns unused. It performs the following steps when called:

  1. Let runningContext be the running execution context.
  2. Let asyncContext be a copy of runningContext.
  3. NOTE: Copying the execution state is required for AsyncBlockStart to resume its execution. It is ill-defined to resume a currently executing context.
  4. Perform AsyncBlockStart(promiseCapability, asyncFunctionBody, asyncContext).
  5. Return unused.

27.7.5.2 AsyncBlockStart ( promiseCapability, asyncBody, asyncContext )

The abstract operation AsyncBlockStart takes arguments promiseCapability (a PromiseCapability Record), asyncBody (a Parse Node or an Abstract Closure with no parameters), and asyncContext (an execution context) and returns unused. It performs the following steps when called:

  1. Let runningContext be the running execution context.
  2. Let closure be a new Abstract Closure with no parameters that captures promiseCapability and asyncBody and performs the following steps when called:
    1. Let acAsyncContext be the running execution context.
    2. If asyncBody is a Parse Node, then
      1. Let result be Completion(Evaluation of asyncBody).
    3. Else,
      1. Assert: asyncBody is an Abstract Closure with no parameters.
      2. Let result be Completion(asyncBody()).
    4. Assert: If we return here, the async function either threw an exception or performed an implicit or explicit return; all awaiting is done.
    5. Remove acAsyncContext from the execution context stack and restore the execution context that is at the top of the execution context stack as the running execution context.
    6. If result is a normal completion, then
      1. Perform ! Call(promiseCapability.[[Resolve]], undefined, « undefined »).
    7. Else if result is a return completion, then
      1. Perform ! Call(promiseCapability.[[Resolve]], undefined, « result.[[Value]] »).
    8. Else,
      1. Assert: result is a throw completion.
      2. Perform ! Call(promiseCapability.[[Reject]], undefined, « result.[[Value]] »).
    9. Return NormalCompletion(unused).
  3. Set the code evaluation state of asyncContext such that when evaluation is resumed for that execution context, closure will be called with no arguments.
  4. Push asyncContext onto the execution context stack; asyncContext is now the running execution context.
  5. Resume the suspended evaluation of asyncContext. Let result be the value returned by the resumed computation.
  6. Assert: When we return here, asyncContext has already been removed from the execution context stack and runningContext is the currently running execution context.
  7. Assert: result is a normal completion with a value of unused. The possible sources of this value are Await or, if the async function doesn't await anything, step 2.i above.
  8. Return unused.

27.7.5.3 Await ( value )

The abstract operation Await takes argument value (an ECMAScript language value) and returns either a normal completion containing either an ECMAScript language value or empty, or a throw completion. It performs the following steps when called:

  1. Let asyncContext be the running execution context.
  2. Let promise be ? PromiseResolve(%Promise%, value).
  3. Let fulfilledClosure be a new Abstract Closure with parameters (v) that captures asyncContext and performs the following steps when called:
    1. Let prevContext be the running execution context.
    2. Suspend prevContext.
    3. Push asyncContext onto the execution context stack; asyncContext is now the running execution context.
    4. Resume the suspended evaluation of asyncContext using NormalCompletion(v) as the result of the operation that suspended it.
    5. Assert: When we reach this step, asyncContext has already been removed from the execution context stack and prevContext is the currently running execution context.
    6. Return NormalCompletion(undefined).
  4. Let onFulfilled be CreateBuiltinFunction(fulfilledClosure, 1, "", « »).
  5. Let rejectedClosure be a new Abstract Closure with parameters (reason) that captures asyncContext and performs the following steps when called:
    1. Let prevContext be the running execution context.
    2. Suspend prevContext.
    3. Push asyncContext onto the execution context stack; asyncContext is now the running execution context.
    4. Resume the suspended evaluation of asyncContext using ThrowCompletion(reason) as the result of the operation that suspended it.
    5. Assert: When we reach this step, asyncContext has already been removed from the execution context stack and prevContext is the currently running execution context.
    6. Return NormalCompletion(undefined).
  6. Let onRejected be CreateBuiltinFunction(rejectedClosure, 1, "", « »).
  7. Perform PerformPromiseThen(promise, onFulfilled, onRejected).
  8. Remove asyncContext from the execution context stack and restore the execution context that is at the top of the execution context stack as the running execution context.
  9. Let callerContext be the running execution context.
  10. Resume callerContext passing empty. If asyncContext is ever resumed again, let completion be the Completion Record with which it is resumed.
  11. Assert: If control reaches here, then asyncContext is the running execution context again.
  12. Return completion.

28 Reflection

28.1 The Reflect Object

The Reflect object:

  • is %Reflect%.
  • is the initial value of the "Reflect" property of the global object.
  • is an ordinary object.
  • has a [[Prototype]] internal slot whose value is %Object.prototype%.
  • is not a function object.
  • does not have a [[Construct]] internal method; it cannot be used as a constructor with the new operator.
  • does not have a [[Call]] internal method; it cannot be invoked as a function.

28.1.1 Reflect.apply ( target, thisArgument, argumentsList )

This function performs the following steps when called:

  1. If IsCallable(target) is false, throw a TypeError exception.
  2. Let args be ? CreateListFromArrayLike(argumentsList).
  3. Perform PrepareForTailCall().
  4. Return ? Call(target, thisArgument, args).

28.1.2 Reflect.construct ( target, argumentsList [ , newTarget ] )

This function performs the following steps when called:

  1. If IsConstructor(target) is false, throw a TypeError exception.
  2. If newTarget is not present, set newTarget to target.
  3. Else if IsConstructor(newTarget) is false, throw a TypeError exception.
  4. Let args be ? CreateListFromArrayLike(argumentsList).
  5. Return ? Construct(target, args, newTarget).

28.1.3 Reflect.defineProperty ( target, propertyKey, attributes )

This function performs the following steps when called:

  1. If target is not an Object, throw a TypeError exception.
  2. Let key be ? ToPropertyKey(propertyKey).
  3. Let desc be ? ToPropertyDescriptor(attributes).
  4. Return ? target.[[DefineOwnProperty]](key, desc).

28.1.4 Reflect.deleteProperty ( target, propertyKey )

This function performs the following steps when called:

  1. If target is not an Object, throw a TypeError exception.
  2. Let key be ? ToPropertyKey(propertyKey).
  3. Return ? target.[[Delete]](key).

28.1.5 Reflect.get ( target, propertyKey [ , receiver ] )

This function performs the following steps when called:

  1. If target is not an Object, throw a TypeError exception.
  2. Let key be ? ToPropertyKey(propertyKey).
  3. If receiver is not present, then
    1. Set receiver to target.
  4. Return ? target.[[Get]](key, receiver).

28.1.6 Reflect.getOwnPropertyDescriptor ( target, propertyKey )

This function performs the following steps when called:

  1. If target is not an Object, throw a TypeError exception.
  2. Let key be ? ToPropertyKey(propertyKey).
  3. Let desc be ? target.[[GetOwnProperty]](key).
  4. Return FromPropertyDescriptor(desc).

28.1.7 Reflect.getPrototypeOf ( target )

This function performs the following steps when called:

  1. If target is not an Object, throw a TypeError exception.
  2. Return ? target.[[GetPrototypeOf]]().

28.1.8 Reflect.has ( target, propertyKey )

This function performs the following steps when called:

  1. If target is not an Object, throw a TypeError exception.
  2. Let key be ? ToPropertyKey(propertyKey).
  3. Return ? target.[[HasProperty]](key).

28.1.9 Reflect.isExtensible ( target )

This function performs the following steps when called:

  1. If target is not an Object, throw a TypeError exception.
  2. Return ? target.[[IsExtensible]]().

28.1.10 Reflect.ownKeys ( target )

This function performs the following steps when called:

  1. If target is not an Object, throw a TypeError exception.
  2. Let keys be ? target.[[OwnPropertyKeys]]().
  3. Return CreateArrayFromList(keys).

28.1.11 Reflect.preventExtensions ( target )

This function performs the following steps when called:

  1. If target is not an Object, throw a TypeError exception.
  2. Return ? target.[[PreventExtensions]]().

28.1.12 Reflect.set ( target, propertyKey, V [ , receiver ] )

This function performs the following steps when called:

  1. If target is not an Object, throw a TypeError exception.
  2. Let key be ? ToPropertyKey(propertyKey).
  3. If receiver is not present, then
    1. Set receiver to target.
  4. Return ? target.[[Set]](key, V, receiver).

28.1.13 Reflect.setPrototypeOf ( target, proto )

This function performs the following steps when called:

  1. If target is not an Object, throw a TypeError exception.
  2. If proto is not an Object and proto is not null, throw a TypeError exception.
  3. Return ? target.[[SetPrototypeOf]](proto).

28.1.14 Reflect [ %Symbol.toStringTag% ]

The initial value of the %Symbol.toStringTag% property is the String value "Reflect".

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: true }.

28.2 Proxy Objects

28.2.1 The Proxy Constructor

The Proxy constructor:

  • is %Proxy%.
  • is the initial value of the "Proxy" property of the global object.
  • creates and initializes a new Proxy object when called as a constructor.
  • is not intended to be called as a function and will throw an exception when called in that manner.

28.2.1.1 Proxy ( target, handler )

This function performs the following steps when called:

  1. If NewTarget is undefined, throw a TypeError exception.
  2. Return ? ProxyCreate(target, handler).

28.2.2 Properties of the Proxy Constructor

The Proxy constructor:

  • has a [[Prototype]] internal slot whose value is %Function.prototype%.
  • does not have a "prototype" property because Proxy objects do not have a [[Prototype]] internal slot that requires initialization.
  • has the following properties:

28.2.2.1 Proxy.revocable ( target, handler )

This function creates a revocable Proxy object.

It performs the following steps when called:

  1. Let proxy be ? ProxyCreate(target, handler).
  2. Let revokerClosure be a new Abstract Closure with no parameters that captures nothing and performs the following steps when called:
    1. Let F be the active function object.
    2. Let p be F.[[RevocableProxy]].
    3. If p is null, return NormalCompletion(undefined).
    4. Set F.[[RevocableProxy]] to null.
    5. Assert: p is a Proxy exotic object.
    6. Set p.[[ProxyTarget]] to null.
    7. Set p.[[ProxyHandler]] to null.
    8. Return NormalCompletion(undefined).
  3. Let revoker be CreateBuiltinFunction(revokerClosure, 0, "", « [[RevocableProxy]] »).
  4. Set revoker.[[RevocableProxy]] to proxy.
  5. Let result be OrdinaryObjectCreate(%Object.prototype%).
  6. Perform ! CreateDataPropertyOrThrow(result, "proxy", proxy).
  7. Perform ! CreateDataPropertyOrThrow(result, "revoke", revoker).
  8. Return result.

28.3 Module Namespace Objects

A Module Namespace Object is a module namespace exotic object that provides runtime property-based access to a module's exported bindings. There is no constructor function for Module Namespace Objects. Instead, such an object is created for each module that is imported by an ImportDeclaration that contains a NameSpaceImport.

In addition to the properties specified in 10.4.6 each Module Namespace Object has the following own property:

28.3.1 %Symbol.toStringTag%

The initial value of the %Symbol.toStringTag% property is the String value "Module".

This property has the attributes { [[Writable]]: false, [[Enumerable]]: false, [[Configurable]]: false }.

29 Memory Model

The memory consistency model, or memory model, specifies the possible orderings of Shared Data Block events, arising via accessing TypedArray instances backed by a SharedArrayBuffer and via methods on the Atomics object. When the program has no data races (defined below), the ordering of events appears as sequentially consistent, i.e., as an interleaving of actions from each agent. When the program has data races, shared memory operations may appear sequentially inconsistent. For example, programs may exhibit causality-violating behaviour and other astonishments. These astonishments arise from compiler transforms and the design of CPUs (e.g., out-of-order execution and speculation). The memory model defines both the precise conditions under which a program exhibits sequentially consistent behaviour as well as the possible values read from data races. To wit, there is no undefined behaviour.

The memory model is defined as relational constraints on events introduced by abstract operations on SharedArrayBuffer or by methods on the Atomics object during an evaluation.

Note

This section provides an axiomatic model on events introduced by the abstract operations on SharedArrayBuffers. It bears stressing that the model is not expressible algorithmically, unlike the rest of this specification. The nondeterministic introduction of events by abstract operations is the interface between the operational semantics of ECMAScript evaluation and the axiomatic semantics of the memory model. The semantics of these events is defined by considering graphs of all events in an evaluation. These are neither Static Semantics nor Runtime Semantics. There is no demonstrated algorithmic implementation, but instead a set of constraints that determine if a particular event graph is allowed or disallowed.

29.1 Memory Model Fundamentals

Shared memory accesses (reads and writes) are divided into two groups, atomic accesses and data accesses, defined below. Atomic accesses are sequentially consistent, i.e., there is a strict total ordering of events agreed upon by all agents in an agent cluster. Non-atomic accesses do not have a strict total ordering agreed upon by all agents, i.e., unordered.

Note 1

No orderings weaker than sequentially consistent and stronger than unordered, such as release-acquire, are supported.

A Shared Data Block event is either a ReadSharedMemory, WriteSharedMemory, or ReadModifyWriteSharedMemory Record.

Table 96: ReadSharedMemory Event Fields
Field Name Value Meaning
[[Order]] seq-cst or unordered The weakest ordering guaranteed by the memory model for the event.
[[NoTear]] a Boolean Whether this event is allowed to read from multiple write events with equal range as this event.
[[Block]] a Shared Data Block The block the event operates on.
[[ByteIndex]] a non-negative integer The byte address of the read in [[Block]].
[[ElementSize]] a non-negative integer The size of the read.
Table 97: WriteSharedMemory Event Fields
Field Name Value Meaning
[[Order]] seq-cst, unordered, or init The weakest ordering guaranteed by the memory model for the event.
[[NoTear]] a Boolean Whether this event is allowed to be read from multiple read events with equal range as this event.
[[Block]] a Shared Data Block The block the event operates on.
[[ByteIndex]] a non-negative integer The byte address of the write in [[Block]].
[[ElementSize]] a non-negative integer The size of the write.
[[Payload]] a List of byte values The List of byte values to be read by other events.
Table 98: ReadModifyWriteSharedMemory Event Fields
Field Name Value Meaning
[[Order]] seq-cst Read-modify-write events are always sequentially consistent.
[[NoTear]] true Read-modify-write events cannot tear.
[[Block]] a Shared Data Block The block the event operates on.
[[ByteIndex]] a non-negative integer The byte address of the read-modify-write in [[Block]].
[[ElementSize]] a non-negative integer The size of the read-modify-write.
[[Payload]] a List of byte values The List of byte values to be passed to [[ModifyOp]].
[[ModifyOp]] a read-modify-write modification function An abstract closure that returns a modified List of byte values from a read List of byte values and [[Payload]].

These events are introduced by abstract operations or by methods on the Atomics object.

Some operations may also introduce Synchronize events. A Synchronize event has no fields, and exists purely to directly constrain the permitted orderings of other events.

In addition to Shared Data Block and Synchronize events, there are host-specific events.

Let the range of a ReadSharedMemory, WriteSharedMemory, or ReadModifyWriteSharedMemory event be the Set of contiguous integers from its [[ByteIndex]] to [[ByteIndex]] + [[ElementSize]] - 1. Two events' ranges are equal when the events have the same [[Block]], and the ranges are element-wise equal. Two events' ranges are overlapping when the events have the same [[Block]], the ranges are not equal and their intersection is non-empty. Two events' ranges are disjoint when the events do not have the same [[Block]] or their ranges are neither equal nor overlapping.

Note 2

Examples of host-specific synchronizing events that should be accounted for are: sending a SharedArrayBuffer from one agent to another (e.g., by postMessage in a browser), starting and stopping agents, and communicating within the agent cluster via channels other than shared memory. For a particular execution execution, those events are provided by the host via the host-synchronizes-with strict partial order. Additionally, hosts can add host-specific synchronizing events to execution.[[EventList]] so as to participate in the is-agent-order-before Relation.

Events are ordered within candidate executions by the relations defined below.

29.2 Agent Events Records

An Agent Events Record is a Record with the following fields.

Table 99: Agent Events Record Fields
Field Name Value Meaning
[[AgentSignifier]] an agent signifier The agent whose evaluation resulted in this ordering.
[[EventList]] a List of events Events are appended to the list during evaluation.
[[AgentSynchronizesWith]] a List of pairs of Synchronize events Synchronize relationships introduced by the operational semantics.

29.3 Chosen Value Records

A Chosen Value Record is a Record with the following fields.

Table 100: Chosen Value Record Fields
Field Name Value Meaning
[[Event]] a Shared Data Block event The ReadSharedMemory or ReadModifyWriteSharedMemory event that was introduced for this chosen value.
[[ChosenValue]] a List of byte values The bytes that were nondeterministically chosen during evaluation.

29.4 Candidate Executions

A candidate execution of the evaluation of an agent cluster is a Record with the following fields.

Table 101: Candidate Execution Record Fields
Field Name Value Meaning
[[EventsRecords]] a List of Agent Events Records Maps an agent to Lists of events appended during the evaluation.
[[ChosenValues]] a List of Chosen Value Records Maps ReadSharedMemory or ReadModifyWriteSharedMemory events to the List of byte values chosen during the evaluation.

An empty candidate execution is a candidate execution Record whose fields are empty Lists.

29.5 Abstract Operations for the Memory Model

29.5.1 EventSet ( execution )

The abstract operation EventSet takes argument execution (a candidate execution) and returns a Set of events. It performs the following steps when called:

  1. Let events be an empty Set.
  2. For each Agent Events Record aer of execution.[[EventsRecords]], do
    1. For each event E of aer.[[EventList]], do
      1. Add E to events.
  3. Return events.

29.5.2 SharedDataBlockEventSet ( execution )

The abstract operation SharedDataBlockEventSet takes argument execution (a candidate execution) and returns a Set of events. It performs the following steps when called:

  1. Let events be an empty Set.
  2. For each event E of EventSet(execution), do
    1. If E is a ReadSharedMemory, WriteSharedMemory, or ReadModifyWriteSharedMemory event, add E to events.
  3. Return events.

29.5.3 HostEventSet ( execution )

The abstract operation HostEventSet takes argument execution (a candidate execution) and returns a Set of events. It performs the following steps when called:

  1. Let events be an empty Set.
  2. For each event E of EventSet(execution), do
    1. If E is not in SharedDataBlockEventSet(execution), add E to events.
  3. Return events.

29.5.4 ComposeWriteEventBytes ( execution, byteIndex, Ws )

The abstract operation ComposeWriteEventBytes takes arguments execution (a candidate execution), byteIndex (a non-negative integer), and Ws (a List of either WriteSharedMemory or ReadModifyWriteSharedMemory events) and returns a List of byte values. It performs the following steps when called:

  1. Let byteLocation be byteIndex.
  2. Let bytesRead be a new empty List.
  3. For each element W of Ws, do
    1. Assert: W has byteLocation in its range.
    2. Let payloadIndex be byteLocation - W.[[ByteIndex]].
    3. If W is a WriteSharedMemory event, then
      1. Let byte be W.[[Payload]][payloadIndex].
    4. Else,
      1. Assert: W is a ReadModifyWriteSharedMemory event.
      2. Let bytes be ValueOfReadEvent(execution, W).
      3. Let bytesModified be W.[[ModifyOp]](bytes, W.[[Payload]]).
      4. Let byte be bytesModified[payloadIndex].
    5. Append byte to bytesRead.
    6. Set byteLocation to byteLocation + 1.
  4. Return bytesRead.
Note 1

The read-modify-write modification [[ModifyOp]] is given by the function properties on the Atomics object that introduce ReadModifyWriteSharedMemory events.

Note 2

This abstract operation composes a List of write events into a List of byte values. It is used in the event semantics of ReadSharedMemory and ReadModifyWriteSharedMemory events.

29.5.5 ValueOfReadEvent ( execution, R )

The abstract operation ValueOfReadEvent takes arguments execution (a candidate execution) and R (a ReadSharedMemory or ReadModifyWriteSharedMemory event) and returns a List of byte values. It performs the following steps when called:

  1. Let Ws be reads-bytes-from(R) in execution.
  2. Assert: Ws is a List of WriteSharedMemory or ReadModifyWriteSharedMemory events with length equal to R.[[ElementSize]].
  3. Return ComposeWriteEventBytes(execution, R.[[ByteIndex]], Ws).

29.6 Relations of Candidate Executions

The following relations and mathematical functions are parameterized over a particular candidate execution and order its events.

29.6.1 is-agent-order-before

For a candidate execution execution, its is-agent-order-before Relation is the least Relation on events that satisfies the following.

  • For events E and D, E is-agent-order-before D in execution if there is some Agent Events Record aer in execution.[[EventsRecords]] such that aer.[[EventList]] contains both E and D and E is before D in List order of aer.[[EventList]].
Note

Each agent introduces events in a per-agent strict total order during the evaluation. This is the union of those strict total orders.

29.6.2 reads-bytes-from

For a candidate execution execution, its reads-bytes-from function is a mathematical function mapping events in SharedDataBlockEventSet(execution) to Lists of events in SharedDataBlockEventSet(execution) that satisfies the following conditions.

A candidate execution always admits a reads-bytes-from function.

29.6.3 reads-from

For a candidate execution execution, its reads-from Relation is the least Relation on events that satisfies the following.

29.6.4 host-synchronizes-with

For a candidate execution execution, its host-synchronizes-with Relation is a host-provided strict partial order on host-specific events that satisfies at least the following.

  • If E host-synchronizes-with D in execution, HostEventSet(execution) contains E and D.
  • There is no cycle in the union of host-synchronizes-with and is-agent-order-before in execution.
Note 1

For two host-specific events E and D in a candidate execution execution, E host-synchronizes-with D in execution implies E happens-before D in execution.

Note 2

This Relation allows the host to provide additional synchronization mechanisms, such as postMessage between HTML workers.

29.6.5 synchronizes-with

For a candidate execution execution, its synchronizes-with Relation is the least Relation on events that satisfies the following.

  • For events R and W, W synchronizes-with R in execution if R reads-from W in execution, R.[[Order]] is seq-cst, W.[[Order]] is seq-cst, and R and W have equal ranges.
  • For each element eventsRecord of execution.[[EventsRecords]], the following is true.
    • For events S and Sw, S synchronizes-with Sw in execution if eventsRecord.[[AgentSynchronizesWith]] contains (S, Sw).
  • For events E and D, E synchronizes-with D in execution if execution.[[HostSynchronizesWith]] contains (E, D).
Note 1

Owing to convention in memory model literature, in a candidate execution execution, write events synchronizes-with read events, instead of read events synchronizes-with write events.

Note 2

In a candidate execution execution, init events do not participate in this Relation and are instead constrained directly by happens-before.

Note 3

In a candidate execution execution, not all seq-cst events related by reads-from are related by synchronizes-with. Only events that also have equal ranges are related by synchronizes-with.

Note 4

For Shared Data Block events R and W in a candidate execution execution such that W synchronizes-with R, R may reads-from other writes than W.

29.6.6 happens-before

For a candidate execution execution, its happens-before Relation is the least Relation on events that satisfies the following.

  • For events E and D, E happens-before D in execution if any of the following conditions are true.

Note

Because happens-before is a superset of agent-order, a candidate execution is consistent with the single-thread evaluation semantics of ECMAScript.

29.7 Properties of Valid Executions

29.7.1 Valid Chosen Reads

A candidate execution execution has valid chosen reads if the following algorithm returns true.

  1. For each ReadSharedMemory or ReadModifyWriteSharedMemory event R of SharedDataBlockEventSet(execution), do
    1. Let chosenValueRecord be the element of execution.[[ChosenValues]] whose [[Event]] field is R.
    2. Let chosenValue be chosenValueRecord.[[ChosenValue]].
    3. Let readValue be ValueOfReadEvent(execution, R).
    4. Let chosenLen be the number of elements in chosenValue.
    5. Let readLen be the number of elements in readValue.
    6. If chosenLenreadLen, then
      1. Return false.
    7. If chosenValue[i] ≠ readValue[i] for some integer i in the interval from 0 (inclusive) to chosenLen (exclusive), then
      1. Return false.
  2. Return true.

29.7.2 Coherent Reads

A candidate execution execution has coherent reads if the following algorithm returns true.

  1. For each ReadSharedMemory or ReadModifyWriteSharedMemory event R of SharedDataBlockEventSet(execution), do
    1. Let Ws be reads-bytes-from(R) in execution.
    2. Let byteLocation be R.[[ByteIndex]].
    3. For each element W of Ws, do
      1. If R happens-before W in execution, then
        1. Return false.
      2. If there exists a WriteSharedMemory or ReadModifyWriteSharedMemory event V that has byteLocation in its range such that W happens-before V in execution and V happens-before R in execution, then
        1. Return false.
      3. Set byteLocation to byteLocation + 1.
  2. Return true.

29.7.3 Tear Free Reads

A candidate execution execution has tear free reads if the following algorithm returns true.

  1. For each ReadSharedMemory or ReadModifyWriteSharedMemory event R of SharedDataBlockEventSet(execution), do
    1. If R.[[NoTear]] is true, then
      1. Assert: The remainder of dividing R.[[ByteIndex]] by R.[[ElementSize]] is 0.
      2. For each event W such that R reads-from W in execution and W.[[NoTear]] is true, do
        1. If R and W have equal ranges and there exists an event V such that V and W have equal ranges, V.[[NoTear]] is true, W and V are not the same Shared Data Block event, and R reads-from V in execution, then
          1. Return false.
  2. Return true.
Note

An event's [[NoTear]] field is true when that event was introduced via accessing an integer TypedArray, and false when introduced via accessing a floating point TypedArray or DataView.

Intuitively, this requirement says when a memory range is accessed in an aligned fashion via an integer TypedArray, a single write event on that range must "win" when in a data race with other write events with equal ranges. More precisely, this requirement says an aligned read event cannot read a value composed of bytes from multiple, different write events all with equal ranges. It is possible, however, for an aligned read event to read from multiple write events with overlapping ranges.

29.7.4 Sequentially Consistent Atomics

For a candidate execution execution, is-memory-order-before is a strict total order of all events in EventSet(execution) that satisfies the following.

A candidate execution has sequentially consistent atomics if it admits an is-memory-order-before Relation.

Note 3

While is-memory-order-before includes all events in EventSet(execution), those that are not constrained by happens-before or synchronizes-with in execution are allowed to occur anywhere in the order.

29.7.5 Valid Executions

A candidate execution execution is a valid execution (or simply an execution) if all of the following are true.

All programs have at least one valid execution.

29.8 Races

For an execution execution and events E and D that are contained in SharedDataBlockEventSet(execution), E and D are in a race if the following algorithm returns true.

  1. If E and D are not the same Shared Data Block event, then
    1. If it is not the case that both E happens-before D in execution and D happens-before E in execution, then
      1. If E and D are both WriteSharedMemory or ReadModifyWriteSharedMemory events and E and D do not have disjoint ranges, then
        1. Return true.
      2. If E reads-from D in execution or D reads-from E in execution, then
        1. Return true.
  2. Return false.

29.9 Data Races

For an execution execution and events E and D that are contained in SharedDataBlockEventSet(execution), E and D are in a data race if the following algorithm returns true.

  1. If E and D are in a race in execution, then
    1. If E.[[Order]] is not seq-cst or D.[[Order]] is not seq-cst, then
      1. Return true.
    2. If E and D have overlapping ranges, then
      1. Return true.
  2. Return false.

29.10 Data Race Freedom

An execution execution is data race free if there are no two events in SharedDataBlockEventSet(execution) that are in a data race.

A program is data race free if all its executions are data race free.

The memory model guarantees sequential consistency of all events for data race free programs.

29.11 Shared Memory Guidelines

Note 1

The following are guidelines for ECMAScript programmers working with shared memory.

We recommend programs be kept data race free, i.e., make it so that it is impossible for there to be concurrent non-atomic operations on the same memory location. Data race free programs have interleaving semantics where each step in the evaluation semantics of each agent are interleaved with each other. For data race free programs, it is not necessary to understand the details of the memory model. The details are unlikely to build intuition that will help one to better write ECMAScript.

More generally, even if a program is not data race free it may have predictable behaviour, so long as atomic operations are not involved in any data races and the operations that race all have the same access size. The simplest way to arrange for atomics not to be involved in races is to ensure that different memory cells are used by atomic and non-atomic operations and that atomic accesses of different sizes are not used to access the same cells at the same time. Effectively, the program should treat shared memory as strongly typed as much as possible. One still cannot depend on the ordering and timing of non-atomic accesses that race, but if memory is treated as strongly typed the racing accesses will not "tear" (bits of their values will not be mixed).

Note 2

The following are guidelines for ECMAScript implementers writing compiler transformations for programs using shared memory.

It is desirable to allow most program transformations that are valid in a single-agent setting in a multi-agent setting, to ensure that the performance of each agent in a multi-agent program is as good as it would be in a single-agent setting. Frequently these transformations are hard to judge. We outline some rules about program transformations that are intended to be taken as normative (in that they are implied by the memory model or stronger than what the memory model implies) but which are likely not exhaustive. These rules are intended to apply to program transformations that precede the introductions of the events that make up the is-agent-order-before Relation.

Let an agent-order slice be the subset of the is-agent-order-before Relation pertaining to a single agent.

Let possible read values of a read event be the set of all values of ValueOfReadEvent for that event across all valid executions.

Any transformation of an agent-order slice that is valid in the absence of shared memory is valid in the presence of shared memory, with the following exceptions.

  • Atomics are carved in stone: Program transformations must not cause the seq-cst events in an agent-order slice to be reordered with its unordered operations, nor its seq-cst operations to be reordered with each other, nor may a program transformation remove a seq-cst operation from the is-agent-order-before Relation.

    (In practice, the prohibition on reorderings forces a compiler to assume that every seq-cst operation is a synchronization and included in the final is-memory-order-before Relation, which it would usually have to assume anyway in the absence of inter-agent program analysis. It also forces the compiler to assume that every call where the callee's effects on the memory-order are unknown may contain seq-cst operations.)

  • Reads must be stable: Any given shared memory read must only observe a single value in an execution.

    (For example, if what is semantically a single read in the program is executed multiple times then the program is subsequently allowed to observe only one of the values read. A transformation known as rematerialization can violate this rule.)

  • Writes must be stable: All observable writes to shared memory must follow from program semantics in an execution.

    (For example, a transformation may not introduce certain observable writes, such as by using read-modify-write operations on a larger location to write a smaller datum, writing a value to memory that the program could not have written, or writing a just-read value back to the location it was read from, if that location could have been overwritten by another agent after the read.)

  • Possible read values must be non-empty: Program transformations cannot cause the possible read values of a shared memory read to become empty.

    (Counterintuitively, this rule in effect restricts transformations on writes, because writes have force in memory model insofar as to be read by read events. For example, writes may be moved and coalesced and sometimes reordered between two seq-cst operations, but the transformation may not remove every write that updates a location; some write must be preserved.)

Examples of transformations that remain valid are: merging multiple non-atomic reads from the same location, reordering non-atomic reads, introducing speculative non-atomic reads, merging multiple non-atomic writes to the same location, reordering non-atomic writes to different locations, and hoisting non-atomic reads out of loops even if that affects termination. Note in general that aliased TypedArrays make it hard to prove that locations are different.

Note 3

The following are guidelines for ECMAScript implementers generating machine code for shared memory accesses.

For architectures with memory models no weaker than those of ARM or Power, non-atomic stores and loads may be compiled to bare stores and loads on the target architecture. Atomic stores and loads may be compiled down to instructions that guarantee sequential consistency. If no such instructions exist, memory barriers are to be employed, such as placing barriers on both sides of a bare store or load. Read-modify-write operations may be compiled to read-modify-write instructions on the target architecture, such as LOCK-prefixed instructions on x86, load-exclusive/store-exclusive instructions on ARM, and load-link/store-conditional instructions on Power.

Specifically, the memory model is intended to allow code generation as follows.

  • Every atomic operation in the program is assumed to be necessary.
  • Atomic operations are never rearranged with each other or with non-atomic operations.
  • Functions are always assumed to perform atomic operations.
  • Atomic operations are never implemented as read-modify-write operations on larger data, but as non-lock-free atomics if the platform does not have atomic operations of the appropriate size. (We already assume that every platform has normal memory access operations of every interesting size.)

Naive code generation uses these patterns:

  • Regular loads and stores compile to single load and store instructions.
  • Lock-free atomic loads and stores compile to a full (sequentially consistent) fence, a regular load or store, and a full fence.
  • Lock-free atomic read-modify-write accesses compile to a full fence, an atomic read-modify-write instruction sequence, and a full fence.
  • Non-lock-free atomics compile to a spinlock acquire, a full fence, a series of non-atomic load and store instructions, a full fence, and a spinlock release.

That mapping is correct so long as an atomic operation on an address range does not race with a non-atomic write or with an atomic operation of different size. However, that is all we need: the memory model effectively demotes the atomic operations involved in a race to non-atomic status. On the other hand, the naive mapping is quite strong: it allows atomic operations to be used as sequentially consistent fences, which the memory model does not actually guarantee.

Local improvements to those basic patterns are also allowed, subject to the constraints of the memory model. For example:

  • There are obvious platform-dependent improvements that remove redundant fences. For example, on x86 the fences around lock-free atomic loads and stores can always be omitted except for the fence following a store, and no fence is needed for lock-free read-modify-write instructions, as these all use LOCK-prefixed instructions. On many platforms there are fences of several strengths, and weaker fences can be used in certain contexts without destroying sequential consistency.
  • Most modern platforms support lock-free atomics for all the data sizes required by ECMAScript atomics. Should non-lock-free atomics be needed, the fences surrounding the body of the atomic operation can usually be folded into the lock and unlock steps. The simplest solution for non-lock-free atomics is to have a single lock word per SharedArrayBuffer.
  • There are also more complicated platform-dependent local improvements, requiring some code analysis. For example, two back-to-back fences often have the same effect as a single fence, so if code is generated for two atomic operations in sequence, only a single fence need separate them. On x86, even a single fence separating atomic stores can be omitted, as the fence following a store is only needed to separate the store from a subsequent load.

Annex A (informative) Grammar Summary

A.1 Lexical Grammar

SourceCharacter :: any Unicode code point InputElementDiv :: WhiteSpace LineTerminator Comment CommonToken DivPunctuator RightBracePunctuator InputElementRegExp :: WhiteSpace LineTerminator Comment CommonToken RightBracePunctuator RegularExpressionLiteral InputElementRegExpOrTemplateTail :: WhiteSpace LineTerminator Comment CommonToken RegularExpressionLiteral TemplateSubstitutionTail InputElementTemplateTail :: WhiteSpace LineTerminator Comment CommonToken DivPunctuator TemplateSubstitutionTail InputElementHashbangOrRegExp :: WhiteSpace LineTerminator Comment CommonToken HashbangComment RegularExpressionLiteral WhiteSpace :: <TAB> <VT> <FF> <ZWNBSP> <USP> LineTerminator :: <LF> <CR> <LS> <PS> LineTerminatorSequence :: <LF> <CR> [lookahead ≠ <LF>] <LS> <PS> <CR> <LF> Comment :: MultiLineComment SingleLineComment MultiLineComment :: /* MultiLineCommentCharsopt */ MultiLineCommentChars :: MultiLineNotAsteriskChar MultiLineCommentCharsopt * PostAsteriskCommentCharsopt PostAsteriskCommentChars :: MultiLineNotForwardSlashOrAsteriskChar MultiLineCommentCharsopt * PostAsteriskCommentCharsopt MultiLineNotAsteriskChar :: SourceCharacter but not * MultiLineNotForwardSlashOrAsteriskChar :: SourceCharacter but not one of / or * SingleLineComment :: // SingleLineCommentCharsopt SingleLineCommentChars :: SingleLineCommentChar SingleLineCommentCharsopt SingleLineCommentChar :: SourceCharacter but not LineTerminator HashbangComment :: #! SingleLineCommentCharsopt CommonToken :: IdentifierName PrivateIdentifier Punctuator NumericLiteral StringLiteral Template PrivateIdentifier :: # IdentifierName IdentifierName :: IdentifierStart IdentifierName IdentifierPart IdentifierStart :: IdentifierStartChar \ UnicodeEscapeSequence IdentifierPart :: IdentifierPartChar \ UnicodeEscapeSequence IdentifierStartChar :: UnicodeIDStart $ _ IdentifierPartChar :: UnicodeIDContinue $ AsciiLetter :: one of a b c d e f g h i j k l m n o p q r s t u v w x y z A B C D E F G H I J K L M N O P Q R S T U V W X Y Z UnicodeIDStart :: any Unicode code point with the Unicode property “ID_Start” UnicodeIDContinue :: any Unicode code point with the Unicode property “ID_Continue” ReservedWord :: one of await break case catch class const continue debugger default delete do else enum export extends false finally for function if import in instanceof new null return super switch this throw true try typeof var void while with yield Punctuator :: OptionalChainingPunctuator OtherPunctuator OptionalChainingPunctuator :: ?. [lookahead ∉ DecimalDigit] OtherPunctuator :: one of { ( ) [ ] . ... ; , < > <= >= == != === !== + - * % ** ++ -- << >> >>> & | ^ ! ~ && || ?? ? : = += -= *= %= **= <<= >>= >>>= &= |= ^= &&= ||= ??= => DivPunctuator :: / /= RightBracePunctuator :: } NullLiteral :: null BooleanLiteral :: true false NumericLiteralSeparator :: _ NumericLiteral :: DecimalLiteral DecimalBigIntegerLiteral NonDecimalIntegerLiteral[+Sep] NonDecimalIntegerLiteral[+Sep] BigIntLiteralSuffix LegacyOctalIntegerLiteral DecimalBigIntegerLiteral :: 0 BigIntLiteralSuffix NonZeroDigit DecimalDigits[+Sep]opt BigIntLiteralSuffix NonZeroDigit NumericLiteralSeparator DecimalDigits[+Sep] BigIntLiteralSuffix NonDecimalIntegerLiteral[Sep] :: BinaryIntegerLiteral[?Sep] OctalIntegerLiteral[?Sep] HexIntegerLiteral[?Sep] BigIntLiteralSuffix :: n DecimalLiteral :: DecimalIntegerLiteral . DecimalDigits[+Sep]opt ExponentPart[+Sep]opt . DecimalDigits[+Sep] ExponentPart[+Sep]opt DecimalIntegerLiteral ExponentPart[+Sep]opt DecimalIntegerLiteral :: 0 NonZeroDigit NonZeroDigit NumericLiteralSeparatoropt DecimalDigits[+Sep] NonOctalDecimalIntegerLiteral DecimalDigits[Sep] :: DecimalDigit DecimalDigits[?Sep] DecimalDigit [+Sep] DecimalDigits[+Sep] NumericLiteralSeparator DecimalDigit DecimalDigit :: one of 0 1 2 3 4 5 6 7 8 9 NonZeroDigit :: one of 1 2 3 4 5 6 7 8 9 ExponentPart[Sep] :: ExponentIndicator SignedInteger[?Sep] ExponentIndicator :: one of e E SignedInteger[Sep] :: DecimalDigits[?Sep] + DecimalDigits[?Sep] - DecimalDigits[?Sep] BinaryIntegerLiteral[Sep] :: 0b BinaryDigits[?Sep] 0B BinaryDigits[?Sep] BinaryDigits[Sep] :: BinaryDigit BinaryDigits[?Sep] BinaryDigit [+Sep] BinaryDigits[+Sep] NumericLiteralSeparator BinaryDigit BinaryDigit :: one of 0 1 OctalIntegerLiteral[Sep] :: 0o OctalDigits[?Sep] 0O OctalDigits[?Sep] OctalDigits[Sep] :: OctalDigit OctalDigits[?Sep] OctalDigit [+Sep] OctalDigits[+Sep] NumericLiteralSeparator OctalDigit LegacyOctalIntegerLiteral :: 0 OctalDigit LegacyOctalIntegerLiteral OctalDigit NonOctalDecimalIntegerLiteral :: 0 NonOctalDigit LegacyOctalLikeDecimalIntegerLiteral NonOctalDigit NonOctalDecimalIntegerLiteral DecimalDigit LegacyOctalLikeDecimalIntegerLiteral :: 0 OctalDigit LegacyOctalLikeDecimalIntegerLiteral OctalDigit OctalDigit :: one of 0 1 2 3 4 5 6 7 NonOctalDigit :: one of 8 9 HexIntegerLiteral[Sep] :: 0x HexDigits[?Sep] 0X HexDigits[?Sep] HexDigits[Sep] :: HexDigit HexDigits[?Sep] HexDigit [+Sep] HexDigits[+Sep] NumericLiteralSeparator HexDigit HexDigit :: one of 0 1 2 3 4 5 6 7 8 9 a b c d e f A B C D E F StringLiteral :: " DoubleStringCharactersopt " ' SingleStringCharactersopt ' DoubleStringCharacters :: DoubleStringCharacter DoubleStringCharactersopt SingleStringCharacters :: SingleStringCharacter SingleStringCharactersopt DoubleStringCharacter :: SourceCharacter but not one of " or \ or LineTerminator <LS> <PS> \ EscapeSequence LineContinuation SingleStringCharacter :: SourceCharacter but not one of ' or \ or LineTerminator <LS> <PS> \ EscapeSequence LineContinuation LineContinuation :: \ LineTerminatorSequence EscapeSequence :: CharacterEscapeSequence 0 [lookahead ∉ DecimalDigit] LegacyOctalEscapeSequence NonOctalDecimalEscapeSequence HexEscapeSequence UnicodeEscapeSequence CharacterEscapeSequence :: SingleEscapeCharacter NonEscapeCharacter SingleEscapeCharacter :: one of ' " \ b f n r t v NonEscapeCharacter :: SourceCharacter but not one of EscapeCharacter or LineTerminator EscapeCharacter :: SingleEscapeCharacter DecimalDigit x u LegacyOctalEscapeSequence :: 0 [lookahead ∈ { 8, 9 }] NonZeroOctalDigit [lookahead ∉ OctalDigit] ZeroToThree OctalDigit [lookahead ∉ OctalDigit] FourToSeven OctalDigit ZeroToThree OctalDigit OctalDigit NonZeroOctalDigit :: OctalDigit but not 0 ZeroToThree :: one of 0 1 2 3 FourToSeven :: one of 4 5 6 7 NonOctalDecimalEscapeSequence :: one of 8 9 HexEscapeSequence :: x HexDigit HexDigit UnicodeEscapeSequence :: u Hex4Digits u{ CodePoint } Hex4Digits :: HexDigit HexDigit HexDigit HexDigit RegularExpressionLiteral :: / RegularExpressionBody / RegularExpressionFlags RegularExpressionBody :: RegularExpressionFirstChar RegularExpressionChars RegularExpressionChars :: [empty] RegularExpressionChars RegularExpressionChar RegularExpressionFirstChar :: RegularExpressionNonTerminator but not one of * or \ or / or [ RegularExpressionBackslashSequence RegularExpressionClass RegularExpressionChar :: RegularExpressionNonTerminator but not one of \ or / or [ RegularExpressionBackslashSequence RegularExpressionClass RegularExpressionBackslashSequence :: \ RegularExpressionNonTerminator RegularExpressionNonTerminator :: SourceCharacter but not LineTerminator RegularExpressionClass :: [ RegularExpressionClassChars ] RegularExpressionClassChars :: [empty] RegularExpressionClassChars RegularExpressionClassChar RegularExpressionClassChar :: RegularExpressionNonTerminator but not one of ] or \ RegularExpressionBackslashSequence RegularExpressionFlags :: [empty] RegularExpressionFlags IdentifierPartChar Template :: NoSubstitutionTemplate TemplateHead NoSubstitutionTemplate :: ` TemplateCharactersopt ` TemplateHead :: ` TemplateCharactersopt ${ TemplateSubstitutionTail :: TemplateMiddle TemplateTail TemplateMiddle :: } TemplateCharactersopt ${ TemplateTail :: } TemplateCharactersopt ` TemplateCharacters :: TemplateCharacter TemplateCharactersopt TemplateCharacter :: $ [lookahead ≠ {] \ TemplateEscapeSequence \ NotEscapeSequence LineContinuation LineTerminatorSequence SourceCharacter but not one of ` or \ or $ or LineTerminator TemplateEscapeSequence :: CharacterEscapeSequence 0 [lookahead ∉ DecimalDigit] HexEscapeSequence UnicodeEscapeSequence NotEscapeSequence :: 0 DecimalDigit DecimalDigit but not 0 x [lookahead ∉ HexDigit] x HexDigit [lookahead ∉ HexDigit] u [lookahead ∉ HexDigit] [lookahead ≠ {] u HexDigit [lookahead ∉ HexDigit] u HexDigit HexDigit [lookahead ∉ HexDigit] u HexDigit HexDigit HexDigit [lookahead ∉ HexDigit] u { [lookahead ∉ HexDigit] u { NotCodePoint [lookahead ∉ HexDigit] u { CodePoint [lookahead ∉ HexDigit] [lookahead ≠ }] NotCodePoint :: HexDigits[~Sep] but only if the MV of HexDigits > 0x10FFFF CodePoint :: HexDigits[~Sep] but only if the MV of HexDigits ≤ 0x10FFFF

A.2 Expressions

IdentifierReference[Yield, Await] : Identifier [~Yield] yield [~Await] await BindingIdentifier[Yield, Await] : Identifier yield await LabelIdentifier[Yield, Await] : Identifier [~Yield] yield [~Await] await Identifier : IdentifierName but not ReservedWord PrimaryExpression[Yield, Await] : this IdentifierReference[?Yield, ?Await] Literal ArrayLiteral[?Yield, ?Await] ObjectLiteral[?Yield, ?Await] FunctionExpression ClassExpression[?Yield, ?Await] GeneratorExpression AsyncFunctionExpression AsyncGeneratorExpression RegularExpressionLiteral TemplateLiteral[?Yield, ?Await, ~Tagged] CoverParenthesizedExpressionAndArrowParameterList[?Yield, ?Await] CoverParenthesizedExpressionAndArrowParameterList[Yield, Await] : ( Expression[+In, ?Yield, ?Await] ) ( Expression[+In, ?Yield, ?Await] , ) ( ) ( ... BindingIdentifier[?Yield, ?Await] ) ( ... BindingPattern[?Yield, ?Await] ) ( Expression[+In, ?Yield, ?Await] , ... BindingIdentifier[?Yield, ?Await] ) ( Expression[+In, ?Yield, ?Await] , ... BindingPattern[?Yield, ?Await] )

When processing an instance of the production
PrimaryExpression[Yield, Await] : CoverParenthesizedExpressionAndArrowParameterList[?Yield, ?Await]
the interpretation of CoverParenthesizedExpressionAndArrowParameterList is refined using the following grammar:

ParenthesizedExpression[Yield, Await] : ( Expression[+In, ?Yield, ?Await] )

 

Literal : NullLiteral BooleanLiteral NumericLiteral StringLiteral ArrayLiteral[Yield, Await] : [ Elisionopt ] [ ElementList[?Yield, ?Await] ] [ ElementList[?Yield, ?Await] , Elisionopt ] ElementList[Yield, Await] : Elisionopt AssignmentExpression[+In, ?Yield, ?Await] Elisionopt SpreadElement[?Yield, ?Await] ElementList[?Yield, ?Await] , Elisionopt AssignmentExpression[+In, ?Yield, ?Await] ElementList[?Yield, ?Await] , Elisionopt SpreadElement[?Yield, ?Await] Elision : , Elision , SpreadElement[Yield, Await] : ... AssignmentExpression[+In, ?Yield, ?Await] ObjectLiteral[Yield, Await] : { } { PropertyDefinitionList[?Yield, ?Await] } { PropertyDefinitionList[?Yield, ?Await] , } PropertyDefinitionList[Yield, Await] : PropertyDefinition[?Yield, ?Await] PropertyDefinitionList[?Yield, ?Await] , PropertyDefinition[?Yield, ?Await] PropertyDefinition[Yield, Await] : IdentifierReference[?Yield, ?Await] CoverInitializedName[?Yield, ?Await] PropertyName[?Yield, ?Await] : AssignmentExpression[+In, ?Yield, ?Await] MethodDefinition[?Yield, ?Await] ... AssignmentExpression[+In, ?Yield, ?Await] PropertyName[Yield, Await] : LiteralPropertyName ComputedPropertyName[?Yield, ?Await] LiteralPropertyName : IdentifierName StringLiteral NumericLiteral ComputedPropertyName[Yield, Await] : [ AssignmentExpression[+In, ?Yield, ?Await] ] CoverInitializedName[Yield, Await] : IdentifierReference[?Yield, ?Await] Initializer[+In, ?Yield, ?Await] Initializer[In, Yield, Await] : = AssignmentExpression[?In, ?Yield, ?Await] TemplateLiteral[Yield, Await, Tagged] : NoSubstitutionTemplate SubstitutionTemplate[?Yield, ?Await, ?Tagged] SubstitutionTemplate[Yield, Await, Tagged] : TemplateHead Expression[+In, ?Yield, ?Await] TemplateSpans[?Yield, ?Await, ?Tagged] TemplateSpans[Yield, Await, Tagged] : TemplateTail TemplateMiddleList[?Yield, ?Await, ?Tagged] TemplateTail TemplateMiddleList[Yield, Await, Tagged] : TemplateMiddle Expression[+In, ?Yield, ?Await] TemplateMiddleList[?Yield, ?Await, ?Tagged] TemplateMiddle Expression[+In, ?Yield, ?Await] MemberExpression[Yield, Await] : PrimaryExpression[?Yield, ?Await] MemberExpression[?Yield, ?Await] [ Expression[+In, ?Yield, ?Await] ] MemberExpression[?Yield, ?Await] . IdentifierName MemberExpression[?Yield, ?Await] TemplateLiteral[?Yield, ?Await, +Tagged] SuperProperty[?Yield, ?Await] MetaProperty new MemberExpression[?Yield, ?Await] Arguments[?Yield, ?Await] MemberExpression[?Yield, ?Await] . PrivateIdentifier SuperProperty[Yield, Await] : super [ Expression[+In, ?Yield, ?Await] ] super . IdentifierName MetaProperty : NewTarget ImportMeta NewTarget : new . target ImportMeta : import . meta NewExpression[Yield, Await] : MemberExpression[?Yield, ?Await] new NewExpression[?Yield, ?Await] CallExpression[Yield, Await] : CoverCallExpressionAndAsyncArrowHead[?Yield, ?Await] SuperCall[?Yield, ?Await] ImportCall[?Yield, ?Await] CallExpression[?Yield, ?Await] Arguments[?Yield, ?Await] CallExpression[?Yield, ?Await] [ Expression[+In, ?Yield, ?Await] ] CallExpression[?Yield, ?Await] . IdentifierName CallExpression[?Yield, ?Await] TemplateLiteral[?Yield, ?Await, +Tagged] CallExpression[?Yield, ?Await] . PrivateIdentifier

When processing an instance of the production
CallExpression[Yield, Await] : CoverCallExpressionAndAsyncArrowHead[?Yield, ?Await]
the interpretation of CoverCallExpressionAndAsyncArrowHead is refined using the following grammar:

CallMemberExpression[Yield, Await] : MemberExpression[?Yield, ?Await] Arguments[?Yield, ?Await]

 

SuperCall[Yield, Await] : super Arguments[?Yield, ?Await] ImportCall[Yield, Await] : import ( AssignmentExpression[+In, ?Yield, ?Await] ,opt ) import ( AssignmentExpression[+In, ?Yield, ?Await] , AssignmentExpression[+In, ?Yield, ?Await] ,opt ) Arguments[Yield, Await] : ( ) ( ArgumentList[?Yield, ?Await] ) ( ArgumentList[?Yield, ?Await] , ) ArgumentList[Yield, Await] : AssignmentExpression[+In, ?Yield, ?Await] ... AssignmentExpression[+In, ?Yield, ?Await] ArgumentList[?Yield, ?Await] , AssignmentExpression[+In, ?Yield, ?Await] ArgumentList[?Yield, ?Await] , ... AssignmentExpression[+In, ?Yield, ?Await] OptionalExpression[Yield, Await] : MemberExpression[?Yield, ?Await] OptionalChain[?Yield, ?Await] CallExpression[?Yield, ?Await] OptionalChain[?Yield, ?Await] OptionalExpression[?Yield, ?Await] OptionalChain[?Yield, ?Await] OptionalChain[Yield, Await] : ?. Arguments[?Yield, ?Await] ?. [ Expression[+In, ?Yield, ?Await] ] ?. IdentifierName ?. TemplateLiteral[?Yield, ?Await, +Tagged] ?. PrivateIdentifier OptionalChain[?Yield, ?Await] Arguments[?Yield, ?Await] OptionalChain[?Yield, ?Await] [ Expression[+In, ?Yield, ?Await] ] OptionalChain[?Yield, ?Await] . IdentifierName OptionalChain[?Yield, ?Await] TemplateLiteral[?Yield, ?Await, +Tagged] OptionalChain[?Yield, ?Await] . PrivateIdentifier LeftHandSideExpression[Yield, Await] : NewExpression[?Yield, ?Await] CallExpression[?Yield, ?Await] OptionalExpression[?Yield, ?Await] UpdateExpression[Yield, Await] : LeftHandSideExpression[?Yield, ?Await] LeftHandSideExpression[?Yield, ?Await] [no LineTerminator here] ++ LeftHandSideExpression[?Yield, ?Await] [no LineTerminator here] -- ++ UnaryExpression[?Yield, ?Await] -- UnaryExpression[?Yield, ?Await] UnaryExpression[Yield, Await] : UpdateExpression[?Yield, ?Await] delete UnaryExpression[?Yield, ?Await] void UnaryExpression[?Yield, ?Await] typeof UnaryExpression[?Yield, ?Await] + UnaryExpression[?Yield, ?Await] - UnaryExpression[?Yield, ?Await] ~ UnaryExpression[?Yield, ?Await] ! UnaryExpression[?Yield, ?Await] [+Await] AwaitExpression[?Yield] ExponentiationExpression[Yield, Await] : UnaryExpression[?Yield, ?Await] UpdateExpression[?Yield, ?Await] ** ExponentiationExpression[?Yield, ?Await] MultiplicativeExpression[Yield, Await] : ExponentiationExpression[?Yield, ?Await] MultiplicativeExpression[?Yield, ?Await] MultiplicativeOperator ExponentiationExpression[?Yield, ?Await] MultiplicativeOperator : one of * / % AdditiveExpression[Yield, Await] : MultiplicativeExpression[?Yield, ?Await] AdditiveExpression[?Yield, ?Await] + MultiplicativeExpression[?Yield, ?Await] AdditiveExpression[?Yield, ?Await] - MultiplicativeExpression[?Yield, ?Await] ShiftExpression[Yield, Await] : AdditiveExpression[?Yield, ?Await] ShiftExpression[?Yield, ?Await] << AdditiveExpression[?Yield, ?Await] ShiftExpression[?Yield, ?Await] >> AdditiveExpression[?Yield, ?Await] ShiftExpression[?Yield, ?Await] >>> AdditiveExpression[?Yield, ?Await] RelationalExpression[In, Yield, Await] : ShiftExpression[?Yield, ?Await] RelationalExpression[?In, ?Yield, ?Await] < ShiftExpression[?Yield, ?Await] RelationalExpression[?In, ?Yield, ?Await] > ShiftExpression[?Yield, ?Await] RelationalExpression[?In, ?Yield, ?Await] <= ShiftExpression[?Yield, ?Await] RelationalExpression[?In, ?Yield, ?Await] >= ShiftExpression[?Yield, ?Await] RelationalExpression[?In, ?Yield, ?Await] instanceof ShiftExpression[?Yield, ?Await] [+In] RelationalExpression[+In, ?Yield, ?Await] in ShiftExpression[?Yield, ?Await] [+In] PrivateIdentifier in ShiftExpression[?Yield, ?Await] EqualityExpression[In, Yield, Await] : RelationalExpression[?In, ?Yield, ?Await] EqualityExpression[?In, ?Yield, ?Await] == RelationalExpression[?In, ?Yield, ?Await] EqualityExpression[?In, ?Yield, ?Await] != RelationalExpression[?In, ?Yield, ?Await] EqualityExpression[?In, ?Yield, ?Await] === RelationalExpression[?In, ?Yield, ?Await] EqualityExpression[?In, ?Yield, ?Await] !== RelationalExpression[?In, ?Yield, ?Await] BitwiseANDExpression[In, Yield, Await] : EqualityExpression[?In, ?Yield, ?Await] BitwiseANDExpression[?In, ?Yield, ?Await] & EqualityExpression[?In, ?Yield, ?Await] BitwiseXORExpression[In, Yield, Await] : BitwiseANDExpression[?In, ?Yield, ?Await] BitwiseXORExpression[?In, ?Yield, ?Await] ^ BitwiseANDExpression[?In, ?Yield, ?Await] BitwiseORExpression[In, Yield, Await] : BitwiseXORExpression[?In, ?Yield, ?Await] BitwiseORExpression[?In, ?Yield, ?Await] | BitwiseXORExpression[?In, ?Yield, ?Await] LogicalANDExpression[In, Yield, Await] : BitwiseORExpression[?In, ?Yield, ?Await] LogicalANDExpression[?In, ?Yield, ?Await] && BitwiseORExpression[?In, ?Yield, ?Await] LogicalORExpression[In, Yield, Await] : LogicalANDExpression[?In, ?Yield, ?Await] LogicalORExpression[?In, ?Yield, ?Await] || LogicalANDExpression[?In, ?Yield, ?Await] CoalesceExpression[In, Yield, Await] : CoalesceExpressionHead[?In, ?Yield, ?Await] ?? BitwiseORExpression[?In, ?Yield, ?Await] CoalesceExpressionHead[In, Yield, Await] : CoalesceExpression[?In, ?Yield, ?Await] BitwiseORExpression[?In, ?Yield, ?Await] ShortCircuitExpression[In, Yield, Await] : LogicalORExpression[?In, ?Yield, ?Await] CoalesceExpression[?In, ?Yield, ?Await] ConditionalExpression[In, Yield, Await] : ShortCircuitExpression[?In, ?Yield, ?Await] ShortCircuitExpression[?In, ?Yield, ?Await] ? AssignmentExpression[+In, ?Yield, ?Await] : AssignmentExpression[?In, ?Yield, ?Await] AssignmentExpression[In, Yield, Await] : ConditionalExpression[?In, ?Yield, ?Await] [+Yield] YieldExpression[?In, ?Await] ArrowFunction[?In, ?Yield, ?Await] AsyncArrowFunction[?In, ?Yield, ?Await] LeftHandSideExpression[?Yield, ?Await] = AssignmentExpression[?In, ?Yield, ?Await] LeftHandSideExpression[?Yield, ?Await] AssignmentOperator AssignmentExpression[?In, ?Yield, ?Await] LeftHandSideExpression[?Yield, ?Await] &&= AssignmentExpression[?In, ?Yield, ?Await] LeftHandSideExpression[?Yield, ?Await] ||= AssignmentExpression[?In, ?Yield, ?Await] LeftHandSideExpression[?Yield, ?Await] ??= AssignmentExpression[?In, ?Yield, ?Await] AssignmentOperator : one of *= /= %= += -= <<= >>= >>>= &= ^= |= **=

In certain circumstances when processing an instance of the production
AssignmentExpression[In, Yield, Await] : LeftHandSideExpression[?Yield, ?Await] = AssignmentExpression[?In, ?Yield, ?Await]
the interpretation of LeftHandSideExpression is refined using the following grammar:

AssignmentPattern[Yield, Await] : ObjectAssignmentPattern[?Yield, ?Await] ArrayAssignmentPattern[?Yield, ?Await] ObjectAssignmentPattern[Yield, Await] : { } { AssignmentRestProperty[?Yield, ?Await] } { AssignmentPropertyList[?Yield, ?Await] } { AssignmentPropertyList[?Yield, ?Await] , AssignmentRestProperty[?Yield, ?Await]opt } ArrayAssignmentPattern[Yield, Await] : [ Elisionopt AssignmentRestElement[?Yield, ?Await]opt ] [ AssignmentElementList[?Yield, ?Await] ] [ AssignmentElementList[?Yield, ?Await] , Elisionopt AssignmentRestElement[?Yield, ?Await]opt ] AssignmentRestProperty[Yield, Await] : ... DestructuringAssignmentTarget[?Yield, ?Await] AssignmentPropertyList[Yield, Await] : AssignmentProperty[?Yield, ?Await] AssignmentPropertyList[?Yield, ?Await] , AssignmentProperty[?Yield, ?Await] AssignmentElementList[Yield, Await] : AssignmentElisionElement[?Yield, ?Await] AssignmentElementList[?Yield, ?Await] , AssignmentElisionElement[?Yield, ?Await] AssignmentElisionElement[Yield, Await] : Elisionopt AssignmentElement[?Yield, ?Await] AssignmentProperty[Yield, Await] : IdentifierReference[?Yield, ?Await] Initializer[+In, ?Yield, ?Await]opt PropertyName[?Yield, ?Await] : AssignmentElement[?Yield, ?Await] AssignmentElement[Yield, Await] : DestructuringAssignmentTarget[?Yield, ?Await] Initializer[+In, ?Yield, ?Await]opt AssignmentRestElement[Yield, Await] : ... DestructuringAssignmentTarget[?Yield, ?Await] DestructuringAssignmentTarget[Yield, Await] : LeftHandSideExpression[?Yield, ?Await]

 

Expression[In, Yield, Await] : AssignmentExpression[?In, ?Yield, ?Await] Expression[?In, ?Yield, ?Await] , AssignmentExpression[?In, ?Yield, ?Await]

A.3 Statements

Statement[Yield, Await, Return] : BlockStatement[?Yield, ?Await, ?Return] VariableStatement[?Yield, ?Await] EmptyStatement ExpressionStatement[?Yield, ?Await] IfStatement[?Yield, ?Await, ?Return] BreakableStatement[?Yield, ?Await, ?Return] ContinueStatement[?Yield, ?Await] BreakStatement[?Yield, ?Await] [+Return] ReturnStatement[?Yield, ?Await] WithStatement[?Yield, ?Await, ?Return] LabelledStatement[?Yield, ?Await, ?Return] ThrowStatement[?Yield, ?Await] TryStatement[?Yield, ?Await, ?Return] DebuggerStatement Declaration[Yield, Await] : HoistableDeclaration[?Yield, ?Await, ~Default] ClassDeclaration[?Yield, ?Await, ~Default] LexicalDeclaration[+In, ?Yield, ?Await] HoistableDeclaration[Yield, Await, Default] : FunctionDeclaration[?Yield, ?Await, ?Default] GeneratorDeclaration[?Yield, ?Await, ?Default] AsyncFunctionDeclaration[?Yield, ?Await, ?Default] AsyncGeneratorDeclaration[?Yield, ?Await, ?Default] BreakableStatement[Yield, Await, Return] : IterationStatement[?Yield, ?Await, ?Return] SwitchStatement[?Yield, ?Await, ?Return] BlockStatement[Yield, Await, Return] : Block[?Yield, ?Await, ?Return] Block[Yield, Await, Return] : { StatementList[?Yield, ?Await, ?Return]opt } StatementList[Yield, Await, Return] : StatementListItem[?Yield, ?Await, ?Return] StatementList[?Yield, ?Await, ?Return] StatementListItem[?Yield, ?Await, ?Return] StatementListItem[Yield, Await, Return] : Statement[?Yield, ?Await, ?Return] Declaration[?Yield, ?Await] LexicalDeclaration[In, Yield, Await] : LetOrConst BindingList[?In, ?Yield, ?Await] ; LetOrConst : let const BindingList[In, Yield, Await] : LexicalBinding[?In, ?Yield, ?Await] BindingList[?In, ?Yield, ?Await] , LexicalBinding[?In, ?Yield, ?Await] LexicalBinding[In, Yield, Await] : BindingIdentifier[?Yield, ?Await] Initializer[?In, ?Yield, ?Await]opt BindingPattern[?Yield, ?Await] Initializer[?In, ?Yield, ?Await] VariableStatement[Yield, Await] : var VariableDeclarationList[+In, ?Yield, ?Await] ; VariableDeclarationList[In, Yield, Await] : VariableDeclaration[?In, ?Yield, ?Await] VariableDeclarationList[?In, ?Yield, ?Await] , VariableDeclaration[?In, ?Yield, ?Await] VariableDeclaration[In, Yield, Await] : BindingIdentifier[?Yield, ?Await] Initializer[?In, ?Yield, ?Await]opt BindingPattern[?Yield, ?Await] Initializer[?In, ?Yield, ?Await] BindingPattern[Yield, Await] : ObjectBindingPattern[?Yield, ?Await] ArrayBindingPattern[?Yield, ?Await] ObjectBindingPattern[Yield, Await] : { } { BindingRestProperty[?Yield, ?Await] } { BindingPropertyList[?Yield, ?Await] } { BindingPropertyList[?Yield, ?Await] , BindingRestProperty[?Yield, ?Await]opt } ArrayBindingPattern[Yield, Await] : [ Elisionopt BindingRestElement[?Yield, ?Await]opt ] [ BindingElementList[?Yield, ?Await] ] [ BindingElementList[?Yield, ?Await] , Elisionopt BindingRestElement[?Yield, ?Await]opt ] BindingRestProperty[Yield, Await] : ... BindingIdentifier[?Yield, ?Await] BindingPropertyList[Yield, Await] : BindingProperty[?Yield, ?Await] BindingPropertyList[?Yield, ?Await] , BindingProperty[?Yield, ?Await] BindingElementList[Yield, Await] : BindingElisionElement[?Yield, ?Await] BindingElementList[?Yield, ?Await] , BindingElisionElement[?Yield, ?Await] BindingElisionElement[Yield, Await] : Elisionopt BindingElement[?Yield, ?Await] BindingProperty[Yield, Await] : SingleNameBinding[?Yield, ?Await] PropertyName[?Yield, ?Await] : BindingElement[?Yield, ?Await] BindingElement[Yield, Await] : SingleNameBinding[?Yield, ?Await] BindingPattern[?Yield, ?Await] Initializer[+In, ?Yield, ?Await]opt SingleNameBinding[Yield, Await] : BindingIdentifier[?Yield, ?Await] Initializer[+In, ?Yield, ?Await]opt BindingRestElement[Yield, Await] : ... BindingIdentifier[?Yield, ?Await] ... BindingPattern[?Yield, ?Await] EmptyStatement : ; ExpressionStatement[Yield, Await] : [lookahead ∉ { {, function, async [no LineTerminator here] function, class, let [ }] Expression[+In, ?Yield, ?Await] ; IfStatement[Yield, Await, Return] : if ( Expression[+In, ?Yield, ?Await] ) Statement[?Yield, ?Await, ?Return] else Statement[?Yield, ?Await, ?Return] if ( Expression[+In, ?Yield, ?Await] ) Statement[?Yield, ?Await, ?Return] [lookahead ≠ else] IterationStatement[Yield, Await, Return] : DoWhileStatement[?Yield, ?Await, ?Return] WhileStatement[?Yield, ?Await, ?Return] ForStatement[?Yield, ?Await, ?Return] ForInOfStatement[?Yield, ?Await, ?Return] DoWhileStatement[Yield, Await, Return] : do Statement[?Yield, ?Await, ?Return] while ( Expression[+In, ?Yield, ?Await] ) ; WhileStatement[Yield, Await, Return] : while ( Expression[+In, ?Yield, ?Await] ) Statement[?Yield, ?Await, ?Return] ForStatement[Yield, Await, Return] : for ( [lookahead ≠ let [] Expression[~In, ?Yield, ?Await]opt ; Expression[+In, ?Yield, ?Await]opt ; Expression[+In, ?Yield, ?Await]opt ) Statement[?Yield, ?Await, ?Return] for ( var VariableDeclarationList[~In, ?Yield, ?Await] ; Expression[+In, ?Yield, ?Await]opt ; Expression[+In, ?Yield, ?Await]opt ) Statement[?Yield, ?Await, ?Return] for ( LexicalDeclaration[~In, ?Yield, ?Await] Expression[+In, ?Yield, ?Await]opt ; Expression[+In, ?Yield, ?Await]opt ) Statement[?Yield, ?Await, ?Return] ForInOfStatement[Yield, Await, Return] : for ( [lookahead ≠ let [] LeftHandSideExpression[?Yield, ?Await] in Expression[+In, ?Yield, ?Await] ) Statement[?Yield, ?Await, ?Return] for ( var ForBinding[?Yield, ?Await] in Expression[+In, ?Yield, ?Await] ) Statement[?Yield, ?Await, ?Return] for ( ForDeclaration[?Yield, ?Await] in Expression[+In, ?Yield, ?Await] ) Statement[?Yield, ?Await, ?Return] for ( [lookahead ∉ { let, async of }] LeftHandSideExpression[?Yield, ?Await] of AssignmentExpression[+In, ?Yield, ?Await] ) Statement[?Yield, ?Await, ?Return] for ( var ForBinding[?Yield, ?Await] of AssignmentExpression[+In, ?Yield, ?Await] ) Statement[?Yield, ?Await, ?Return] for ( ForDeclaration[?Yield, ?Await] of AssignmentExpression[+In, ?Yield, ?Await] ) Statement[?Yield, ?Await, ?Return] [+Await] for await ( [lookahead ≠ let] LeftHandSideExpression[?Yield, ?Await] of AssignmentExpression[+In, ?Yield, ?Await] ) Statement[?Yield, ?Await, ?Return] [+Await] for await ( var ForBinding[?Yield, ?Await] of AssignmentExpression[+In, ?Yield, ?Await] ) Statement[?Yield, ?Await, ?Return] [+Await] for await ( ForDeclaration[?Yield, ?Await] of AssignmentExpression[+In, ?Yield, ?Await] ) Statement[?Yield, ?Await, ?Return] ForDeclaration[Yield, Await] : LetOrConst ForBinding[?Yield, ?Await] ForBinding[Yield, Await] : BindingIdentifier[?Yield, ?Await] BindingPattern[?Yield, ?Await] ContinueStatement[Yield, Await] : continue ; continue [no LineTerminator here] LabelIdentifier[?Yield, ?Await] ; BreakStatement[Yield, Await] : break ; break [no LineTerminator here] LabelIdentifier[?Yield, ?Await] ; ReturnStatement[Yield, Await] : return ; return [no LineTerminator here] Expression[+In, ?Yield, ?Await] ; WithStatement[Yield, Await, Return] : with ( Expression[+In, ?Yield, ?Await] ) Statement[?Yield, ?Await, ?Return] SwitchStatement[Yield, Await, Return] : switch ( Expression[+In, ?Yield, ?Await] ) CaseBlock[?Yield, ?Await, ?Return] CaseBlock[Yield, Await, Return] : { CaseClauses[?Yield, ?Await, ?Return]opt } { CaseClauses[?Yield, ?Await, ?Return]opt DefaultClause[?Yield, ?Await, ?Return] CaseClauses[?Yield, ?Await, ?Return]opt } CaseClauses[Yield, Await, Return] : CaseClause[?Yield, ?Await, ?Return] CaseClauses[?Yield, ?Await, ?Return] CaseClause[?Yield, ?Await, ?Return] CaseClause[Yield, Await, Return] : case Expression[+In, ?Yield, ?Await] : StatementList[?Yield, ?Await, ?Return]opt DefaultClause[Yield, Await, Return] : default : StatementList[?Yield, ?Await, ?Return]opt LabelledStatement[Yield, Await, Return] : LabelIdentifier[?Yield, ?Await] : LabelledItem[?Yield, ?Await, ?Return] LabelledItem[Yield, Await, Return] : Statement[?Yield, ?Await, ?Return] FunctionDeclaration[?Yield, ?Await, ~Default] ThrowStatement[Yield, Await] : throw [no LineTerminator here] Expression[+In, ?Yield, ?Await] ; TryStatement[Yield, Await, Return] : try Block[?Yield, ?Await, ?Return] Catch[?Yield, ?Await, ?Return] try Block[?Yield, ?Await, ?Return] Finally[?Yield, ?Await, ?Return] try Block[?Yield, ?Await, ?Return] Catch[?Yield, ?Await, ?Return] Finally[?Yield, ?Await, ?Return] Catch[Yield, Await, Return] : catch ( CatchParameter[?Yield, ?Await] ) Block[?Yield, ?Await, ?Return] catch Block[?Yield, ?Await, ?Return] Finally[Yield, Await, Return] : finally Block[?Yield, ?Await, ?Return] CatchParameter[Yield, Await] : BindingIdentifier[?Yield, ?Await] BindingPattern[?Yield, ?Await] DebuggerStatement : debugger ;

A.4 Functions and Classes

UniqueFormalParameters[Yield, Await] : FormalParameters[?Yield, ?Await] FormalParameters[Yield, Await] : [empty] FunctionRestParameter[?Yield, ?Await] FormalParameterList[?Yield, ?Await] FormalParameterList[?Yield, ?Await] , FormalParameterList[?Yield, ?Await] , FunctionRestParameter[?Yield, ?Await] FormalParameterList[Yield, Await] : FormalParameter[?Yield, ?Await] FormalParameterList[?Yield, ?Await] , FormalParameter[?Yield, ?Await] FunctionRestParameter[Yield, Await] : BindingRestElement[?Yield, ?Await] FormalParameter[Yield, Await] : BindingElement[?Yield, ?Await] FunctionDeclaration[Yield, Await, Default] : function BindingIdentifier[?Yield, ?Await] ( FormalParameters[~Yield, ~Await] ) { FunctionBody[~Yield, ~Await] } [+Default] function ( FormalParameters[~Yield, ~Await] ) { FunctionBody[~Yield, ~Await] } FunctionExpression : function BindingIdentifier[~Yield, ~Await]opt ( FormalParameters[~Yield, ~Await] ) { FunctionBody[~Yield, ~Await] } FunctionBody[Yield, Await] : FunctionStatementList[?Yield, ?Await] FunctionStatementList[Yield, Await] : StatementList[?Yield, ?Await, +Return]opt ArrowFunction[In, Yield, Await] : ArrowParameters[?Yield, ?Await] [no LineTerminator here] => ConciseBody[?In] ArrowParameters[Yield, Await] : BindingIdentifier[?Yield, ?Await] CoverParenthesizedExpressionAndArrowParameterList[?Yield, ?Await] ConciseBody[In] : [lookahead ≠ {] ExpressionBody[?In, ~Await] { FunctionBody[~Yield, ~Await] } ExpressionBody[In, Await] : AssignmentExpression[?In, ~Yield, ?Await]

When processing an instance of the production
ArrowParameters[Yield, Await] : CoverParenthesizedExpressionAndArrowParameterList[?Yield, ?Await]
the interpretation of CoverParenthesizedExpressionAndArrowParameterList is refined using the following grammar:

ArrowFormalParameters[Yield, Await] : ( UniqueFormalParameters[?Yield, ?Await] )

 

AsyncArrowFunction[In, Yield, Await] : async [no LineTerminator here] AsyncArrowBindingIdentifier[?Yield] [no LineTerminator here] => AsyncConciseBody[?In] CoverCallExpressionAndAsyncArrowHead[?Yield, ?Await] [no LineTerminator here] => AsyncConciseBody[?In] AsyncConciseBody[In] : [lookahead ≠ {] ExpressionBody[?In, +Await] { AsyncFunctionBody } AsyncArrowBindingIdentifier[Yield] : BindingIdentifier[?Yield, +Await] CoverCallExpressionAndAsyncArrowHead[Yield, Await] : MemberExpression[?Yield, ?Await] Arguments[?Yield, ?Await]

When processing an instance of the production
AsyncArrowFunction[In, Yield, Await] : CoverCallExpressionAndAsyncArrowHead[?Yield, ?Await] [no LineTerminator here] => AsyncConciseBody[?In]
the interpretation of CoverCallExpressionAndAsyncArrowHead is refined using the following grammar:

AsyncArrowHead : async [no LineTerminator here] ArrowFormalParameters[~Yield, +Await]

 

MethodDefinition[Yield, Await] : ClassElementName[?Yield, ?Await] ( UniqueFormalParameters[~Yield, ~Await] ) { FunctionBody[~Yield, ~Await] } GeneratorMethod[?Yield, ?Await] AsyncMethod[?Yield, ?Await] AsyncGeneratorMethod[?Yield, ?Await] get ClassElementName[?Yield, ?Await] ( ) { FunctionBody[~Yield, ~Await] } set ClassElementName[?Yield, ?Await] ( PropertySetParameterList ) { FunctionBody[~Yield, ~Await] } PropertySetParameterList : FormalParameter[~Yield, ~Await] GeneratorDeclaration[Yield, Await, Default] : function * BindingIdentifier[?Yield, ?Await] ( FormalParameters[+Yield, ~Await] ) { GeneratorBody } [+Default] function * ( FormalParameters[+Yield, ~Await] ) { GeneratorBody } GeneratorExpression : function * BindingIdentifier[+Yield, ~Await]opt ( FormalParameters[+Yield, ~Await] ) { GeneratorBody } GeneratorMethod[Yield, Await] : * ClassElementName[?Yield, ?Await] ( UniqueFormalParameters[+Yield, ~Await] ) { GeneratorBody } GeneratorBody : FunctionBody[+Yield, ~Await] YieldExpression[In, Await] : yield yield [no LineTerminator here] AssignmentExpression[?In, +Yield, ?Await] yield [no LineTerminator here] * AssignmentExpression[?In, +Yield, ?Await] AsyncGeneratorDeclaration[Yield, Await, Default] : async [no LineTerminator here] function * BindingIdentifier[?Yield, ?Await] ( FormalParameters[+Yield, +Await] ) { AsyncGeneratorBody } [+Default] async [no LineTerminator here] function * ( FormalParameters[+Yield, +Await] ) { AsyncGeneratorBody } AsyncGeneratorExpression : async [no LineTerminator here] function * BindingIdentifier[+Yield, +Await]opt ( FormalParameters[+Yield, +Await] ) { AsyncGeneratorBody } AsyncGeneratorMethod[Yield, Await] : async [no LineTerminator here] * ClassElementName[?Yield, ?Await] ( UniqueFormalParameters[+Yield, +Await] ) { AsyncGeneratorBody } AsyncGeneratorBody : FunctionBody[+Yield, +Await] AsyncFunctionDeclaration[Yield, Await, Default] : async [no LineTerminator here] function BindingIdentifier[?Yield, ?Await] ( FormalParameters[~Yield, +Await] ) { AsyncFunctionBody } [+Default] async [no LineTerminator here] function ( FormalParameters[~Yield, +Await] ) { AsyncFunctionBody } AsyncFunctionExpression : async [no LineTerminator here] function BindingIdentifier[~Yield, +Await]opt ( FormalParameters[~Yield, +Await] ) { AsyncFunctionBody } AsyncMethod[Yield, Await] : async [no LineTerminator here] ClassElementName[?Yield, ?Await] ( UniqueFormalParameters[~Yield, +Await] ) { AsyncFunctionBody } AsyncFunctionBody : FunctionBody[~Yield, +Await] AwaitExpression[Yield] : await UnaryExpression[?Yield, +Await] ClassDeclaration[Yield, Await, Default] : class BindingIdentifier[?Yield, ?Await] ClassTail[?Yield, ?Await] [+Default] class ClassTail[?Yield, ?Await] ClassExpression[Yield, Await] : class BindingIdentifier[?Yield, ?Await]opt ClassTail[?Yield, ?Await] ClassTail[Yield, Await] : ClassHeritage[?Yield, ?Await]opt { ClassBody[?Yield, ?Await]opt } ClassHeritage[Yield, Await] : extends LeftHandSideExpression[?Yield, ?Await] ClassBody[Yield, Await] : ClassElementList[?Yield, ?Await] ClassElementList[Yield, Await] : ClassElement[?Yield, ?Await] ClassElementList[?Yield, ?Await] ClassElement[?Yield, ?Await] ClassElement[Yield, Await] : MethodDefinition[?Yield, ?Await] static MethodDefinition[?Yield, ?Await] FieldDefinition[?Yield, ?Await] ; static FieldDefinition[?Yield, ?Await] ; ClassStaticBlock ; FieldDefinition[Yield, Await] : ClassElementName[?Yield, ?Await] Initializer[+In, ?Yield, ?Await]opt ClassElementName[Yield, Await] : PropertyName[?Yield, ?Await] PrivateIdentifier ClassStaticBlock : static { ClassStaticBlockBody } ClassStaticBlockBody : ClassStaticBlockStatementList ClassStaticBlockStatementList : StatementList[~Yield, +Await, ~Return]opt

A.5 Scripts and Modules

Script : ScriptBodyopt ScriptBody : StatementList[~Yield, ~Await, ~Return] Module : ModuleBodyopt ModuleBody : ModuleItemList ModuleItemList : ModuleItem ModuleItemList ModuleItem ModuleItem : ImportDeclaration ExportDeclaration StatementListItem[~Yield, +Await, ~Return] ModuleExportName : IdentifierName StringLiteral ImportDeclaration : import ImportClause FromClause WithClauseopt ; import ModuleSpecifier WithClauseopt ; ImportClause : ImportedDefaultBinding NameSpaceImport NamedImports ImportedDefaultBinding , NameSpaceImport ImportedDefaultBinding , NamedImports ImportedDefaultBinding : ImportedBinding NameSpaceImport : * as ImportedBinding NamedImports : { } { ImportsList } { ImportsList , } FromClause : from ModuleSpecifier ImportsList : ImportSpecifier ImportsList , ImportSpecifier ImportSpecifier : ImportedBinding ModuleExportName as ImportedBinding ModuleSpecifier : StringLiteral ImportedBinding : BindingIdentifier[~Yield, +Await] WithClause : with { } with { WithEntries ,opt } WithEntries : AttributeKey : StringLiteral AttributeKey : StringLiteral , WithEntries AttributeKey : IdentifierName StringLiteral ExportDeclaration : export ExportFromClause FromClause WithClauseopt ; export NamedExports ; export VariableStatement[~Yield, +Await] export Declaration[~Yield, +Await] export default HoistableDeclaration[~Yield, +Await, +Default] export default ClassDeclaration[~Yield, +Await, +Default] export default [lookahead ∉ { function, async [no LineTerminator here] function, class }] AssignmentExpression[+In, ~Yield, +Await] ; ExportFromClause : * * as ModuleExportName NamedExports NamedExports : { } { ExportsList } { ExportsList , } ExportsList : ExportSpecifier ExportsList , ExportSpecifier ExportSpecifier : ModuleExportName ModuleExportName as ModuleExportName

A.6 Number Conversions

StringNumericLiteral ::: StrWhiteSpaceopt StrWhiteSpaceopt StrNumericLiteral StrWhiteSpaceopt StrWhiteSpace ::: StrWhiteSpaceChar StrWhiteSpaceopt StrWhiteSpaceChar ::: WhiteSpace LineTerminator StrNumericLiteral ::: StrDecimalLiteral NonDecimalIntegerLiteral[~Sep] StrDecimalLiteral ::: StrUnsignedDecimalLiteral + StrUnsignedDecimalLiteral - StrUnsignedDecimalLiteral StrUnsignedDecimalLiteral ::: Infinity DecimalDigits[~Sep] . DecimalDigits[~Sep]opt ExponentPart[~Sep]opt . DecimalDigits[~Sep] ExponentPart[~Sep]opt DecimalDigits[~Sep] ExponentPart[~Sep]opt

All grammar symbols not explicitly defined by the StringNumericLiteral grammar have the definitions used in the Lexical Grammar for numeric literals.

StringIntegerLiteral ::: StrWhiteSpaceopt StrWhiteSpaceopt StrIntegerLiteral StrWhiteSpaceopt StrIntegerLiteral ::: SignedInteger[~Sep] NonDecimalIntegerLiteral[~Sep]

A.7 Time Zone Offset String Format

UTCOffset ::: ASCIISign Hour ASCIISign Hour HourSubcomponents[+Extended] ASCIISign Hour HourSubcomponents[~Extended] ASCIISign ::: one of + - Hour ::: 0 DecimalDigit 1 DecimalDigit 20 21 22 23 HourSubcomponents[Extended] ::: TimeSeparator[?Extended] MinuteSecond TimeSeparator[?Extended] MinuteSecond TimeSeparator[?Extended] MinuteSecond TemporalDecimalFractionopt TimeSeparator[Extended] ::: [+Extended] : [~Extended] [empty] MinuteSecond ::: 0 DecimalDigit 1 DecimalDigit 2 DecimalDigit 3 DecimalDigit 4 DecimalDigit 5 DecimalDigit TemporalDecimalFraction ::: TemporalDecimalSeparator DecimalDigit TemporalDecimalSeparator DecimalDigit DecimalDigit TemporalDecimalSeparator DecimalDigit DecimalDigit DecimalDigit TemporalDecimalSeparator DecimalDigit DecimalDigit DecimalDigit DecimalDigit TemporalDecimalSeparator DecimalDigit DecimalDigit DecimalDigit DecimalDigit DecimalDigit TemporalDecimalSeparator DecimalDigit DecimalDigit DecimalDigit DecimalDigit DecimalDigit DecimalDigit TemporalDecimalSeparator DecimalDigit DecimalDigit DecimalDigit DecimalDigit DecimalDigit DecimalDigit DecimalDigit TemporalDecimalSeparator DecimalDigit DecimalDigit DecimalDigit DecimalDigit DecimalDigit DecimalDigit DecimalDigit DecimalDigit TemporalDecimalSeparator DecimalDigit DecimalDigit DecimalDigit DecimalDigit DecimalDigit DecimalDigit DecimalDigit DecimalDigit DecimalDigit TemporalDecimalSeparator ::: one of . ,

A.8 Regular Expressions

Pattern[UnicodeMode, UnicodeSetsMode, NamedCaptureGroups] :: Disjunction[?UnicodeMode, ?UnicodeSetsMode, ?NamedCaptureGroups] Disjunction[UnicodeMode, UnicodeSetsMode, NamedCaptureGroups] :: Alternative[?UnicodeMode, ?UnicodeSetsMode, ?NamedCaptureGroups] Alternative[?UnicodeMode, ?UnicodeSetsMode, ?NamedCaptureGroups] | Disjunction[?UnicodeMode, ?UnicodeSetsMode, ?NamedCaptureGroups] Alternative[UnicodeMode, UnicodeSetsMode, NamedCaptureGroups] :: [empty] Alternative[?UnicodeMode, ?UnicodeSetsMode, ?NamedCaptureGroups] Term[?UnicodeMode, ?UnicodeSetsMode, ?NamedCaptureGroups] Term[UnicodeMode, UnicodeSetsMode, NamedCaptureGroups] :: Assertion[?UnicodeMode, ?UnicodeSetsMode, ?NamedCaptureGroups] Atom[?UnicodeMode, ?UnicodeSetsMode, ?NamedCaptureGroups] Atom[?UnicodeMode, ?UnicodeSetsMode, ?NamedCaptureGroups] Quantifier Assertion[UnicodeMode, UnicodeSetsMode, NamedCaptureGroups] :: ^ $ \b \B (?= Disjunction[?UnicodeMode, ?UnicodeSetsMode, ?NamedCaptureGroups] ) (?! Disjunction[?UnicodeMode, ?UnicodeSetsMode, ?NamedCaptureGroups] ) (?<= Disjunction[?UnicodeMode, ?UnicodeSetsMode, ?NamedCaptureGroups] ) (?<! Disjunction[?UnicodeMode, ?UnicodeSetsMode, ?NamedCaptureGroups] ) Quantifier :: QuantifierPrefix QuantifierPrefix ? QuantifierPrefix :: * + ? { DecimalDigits[~Sep] } { DecimalDigits[~Sep] ,} { DecimalDigits[~Sep] , DecimalDigits[~Sep] } Atom[UnicodeMode, UnicodeSetsMode, NamedCaptureGroups] :: PatternCharacter . \ AtomEscape[?UnicodeMode, ?NamedCaptureGroups] CharacterClass[?UnicodeMode, ?UnicodeSetsMode] ( GroupSpecifier[?UnicodeMode]opt Disjunction[?UnicodeMode, ?UnicodeSetsMode, ?NamedCaptureGroups] ) (? RegularExpressionModifiers : Disjunction[?UnicodeMode, ?UnicodeSetsMode, ?NamedCaptureGroups] ) (? RegularExpressionModifiers - RegularExpressionModifiers : Disjunction[?UnicodeMode, ?UnicodeSetsMode, ?NamedCaptureGroups] ) RegularExpressionModifiers :: [empty] RegularExpressionModifiers RegularExpressionModifier RegularExpressionModifier :: one of i m s SyntaxCharacter :: one of ^ $ \ . * + ? ( ) [ ] { } | PatternCharacter :: SourceCharacter but not SyntaxCharacter AtomEscape[UnicodeMode, NamedCaptureGroups] :: DecimalEscape CharacterClassEscape[?UnicodeMode] CharacterEscape[?UnicodeMode] [+NamedCaptureGroups] k GroupName[?UnicodeMode] CharacterEscape[UnicodeMode] :: ControlEscape c AsciiLetter 0 [lookahead ∉ DecimalDigit] HexEscapeSequence RegExpUnicodeEscapeSequence[?UnicodeMode] IdentityEscape[?UnicodeMode] ControlEscape :: one of f n r t v GroupSpecifier[UnicodeMode] :: ? GroupName[?UnicodeMode] GroupName[UnicodeMode] :: < RegExpIdentifierName[?UnicodeMode] > RegExpIdentifierName[UnicodeMode] :: RegExpIdentifierStart[?UnicodeMode] RegExpIdentifierName[?UnicodeMode] RegExpIdentifierPart[?UnicodeMode] RegExpIdentifierStart[UnicodeMode] :: IdentifierStartChar \ RegExpUnicodeEscapeSequence[+UnicodeMode] [~UnicodeMode] UnicodeLeadSurrogate UnicodeTrailSurrogate RegExpIdentifierPart[UnicodeMode] :: IdentifierPartChar \ RegExpUnicodeEscapeSequence[+UnicodeMode] [~UnicodeMode] UnicodeLeadSurrogate UnicodeTrailSurrogate RegExpUnicodeEscapeSequence[UnicodeMode] :: [+UnicodeMode] u HexLeadSurrogate \u HexTrailSurrogate [+UnicodeMode] u HexLeadSurrogate [+UnicodeMode] u HexTrailSurrogate [+UnicodeMode] u HexNonSurrogate [~UnicodeMode] u Hex4Digits [+UnicodeMode] u{ CodePoint } UnicodeLeadSurrogate :: any Unicode code point in the inclusive interval from U+D800 to U+DBFF UnicodeTrailSurrogate :: any Unicode code point in the inclusive interval from U+DC00 to U+DFFF

Each \u HexTrailSurrogate for which the choice of associated u HexLeadSurrogate is ambiguous shall be associated with the nearest possible u HexLeadSurrogate that would otherwise have no corresponding \u HexTrailSurrogate.

 

HexLeadSurrogate :: Hex4Digits but only if the MV of Hex4Digits is in the inclusive interval from 0xD800 to 0xDBFF HexTrailSurrogate :: Hex4Digits but only if the MV of Hex4Digits is in the inclusive interval from 0xDC00 to 0xDFFF HexNonSurrogate :: Hex4Digits but only if the MV of Hex4Digits is not in the inclusive interval from 0xD800 to 0xDFFF IdentityEscape[UnicodeMode] :: [+UnicodeMode] SyntaxCharacter [+UnicodeMode] / [~UnicodeMode] SourceCharacter but not UnicodeIDContinue DecimalEscape :: NonZeroDigit DecimalDigits[~Sep]opt [lookahead ∉ DecimalDigit] CharacterClassEscape[UnicodeMode] :: d D s S w W [+UnicodeMode] p{ UnicodePropertyValueExpression } [+UnicodeMode] P{ UnicodePropertyValueExpression } UnicodePropertyValueExpression :: UnicodePropertyName = UnicodePropertyValue LoneUnicodePropertyNameOrValue UnicodePropertyName :: UnicodePropertyNameCharacters UnicodePropertyNameCharacters :: UnicodePropertyNameCharacter UnicodePropertyNameCharactersopt UnicodePropertyValue :: UnicodePropertyValueCharacters LoneUnicodePropertyNameOrValue :: UnicodePropertyValueCharacters UnicodePropertyValueCharacters :: UnicodePropertyValueCharacter UnicodePropertyValueCharactersopt UnicodePropertyValueCharacter :: UnicodePropertyNameCharacter DecimalDigit UnicodePropertyNameCharacter :: AsciiLetter _ CharacterClass[UnicodeMode, UnicodeSetsMode] :: [ [lookahead ≠ ^] ClassContents[?UnicodeMode, ?UnicodeSetsMode] ] [^ ClassContents[?UnicodeMode, ?UnicodeSetsMode] ] ClassContents[UnicodeMode, UnicodeSetsMode] :: [empty] [~UnicodeSetsMode] NonemptyClassRanges[?UnicodeMode] [+UnicodeSetsMode] ClassSetExpression NonemptyClassRanges[UnicodeMode] :: ClassAtom[?UnicodeMode] ClassAtom[?UnicodeMode] NonemptyClassRangesNoDash[?UnicodeMode] ClassAtom[?UnicodeMode] - ClassAtom[?UnicodeMode] ClassContents[?UnicodeMode, ~UnicodeSetsMode] NonemptyClassRangesNoDash[UnicodeMode] :: ClassAtom[?UnicodeMode] ClassAtomNoDash[?UnicodeMode] NonemptyClassRangesNoDash[?UnicodeMode] ClassAtomNoDash[?UnicodeMode] - ClassAtom[?UnicodeMode] ClassContents[?UnicodeMode, ~UnicodeSetsMode] ClassAtom[UnicodeMode] :: - ClassAtomNoDash[?UnicodeMode] ClassAtomNoDash[UnicodeMode] :: SourceCharacter but not one of \ or ] or - \ ClassEscape[?UnicodeMode] ClassEscape[UnicodeMode] :: b [+UnicodeMode] - CharacterClassEscape[?UnicodeMode] CharacterEscape[?UnicodeMode] ClassSetExpression :: ClassUnion ClassIntersection ClassSubtraction ClassUnion :: ClassSetRange ClassUnionopt ClassSetOperand ClassUnionopt ClassIntersection :: ClassSetOperand && [lookahead ≠ &] ClassSetOperand ClassIntersection && [lookahead ≠ &] ClassSetOperand ClassSubtraction :: ClassSetOperand -- ClassSetOperand ClassSubtraction -- ClassSetOperand ClassSetRange :: ClassSetCharacter - ClassSetCharacter ClassSetOperand :: NestedClass ClassStringDisjunction ClassSetCharacter NestedClass :: [ [lookahead ≠ ^] ClassContents[+UnicodeMode, +UnicodeSetsMode] ] [^ ClassContents[+UnicodeMode, +UnicodeSetsMode] ] \ CharacterClassEscape[+UnicodeMode] ClassStringDisjunction :: \q{ ClassStringDisjunctionContents } ClassStringDisjunctionContents :: ClassString ClassString | ClassStringDisjunctionContents ClassString :: [empty] NonEmptyClassString NonEmptyClassString :: ClassSetCharacter NonEmptyClassStringopt ClassSetCharacter :: [lookahead ∉ ClassSetReservedDoublePunctuator] SourceCharacter but not ClassSetSyntaxCharacter \ CharacterEscape[+UnicodeMode] \ ClassSetReservedPunctuator \b ClassSetReservedDoublePunctuator :: one of && !! ## $$ %% ** ++ ,, .. :: ;; << == >> ?? @@ ^^ `` ~~ ClassSetSyntaxCharacter :: one of ( ) [ ] { } / - \ | ClassSetReservedPunctuator :: one of & - ! # % , : ; < = > @ ` ~

Annex B (normative) Additional ECMAScript Features for Web Browsers

The ECMAScript language syntax and semantics defined in this annex are required when the ECMAScript host is a web browser. The content of this annex is normative but optional if the ECMAScript host is not a web browser.

Note

This annex describes various legacy features and other characteristics of web browser ECMAScript hosts. All of the language features and behaviours specified in this annex have one or more undesirable characteristics and in the absence of legacy usage would be removed from this specification. However, the usage of these features by large numbers of existing web pages means that web browsers must continue to support them. The specifications in this annex define the requirements for interoperable implementations of these legacy features.

These features are not considered part of the core ECMAScript language. Programmers should not use or assume the existence of these features and behaviours when writing new ECMAScript code. ECMAScript implementations are discouraged from implementing these features unless the implementation is part of a web browser or is required to run the same legacy ECMAScript code that web browsers encounter.

B.1 Additional Syntax

B.1.1 HTML-like Comments

The syntax and semantics of 12.4 is extended as follows except that this extension is not allowed when parsing source text using the goal symbol Module:

Syntax

InputElementHashbangOrRegExp :: WhiteSpace LineTerminator Comment CommonToken HashbangComment RegularExpressionLiteral HTMLCloseComment Comment :: MultiLineComment SingleLineComment SingleLineHTMLOpenComment SingleLineHTMLCloseComment SingleLineDelimitedComment MultiLineComment :: /* FirstCommentLineopt LineTerminator MultiLineCommentCharsopt */ HTMLCloseCommentopt FirstCommentLine :: SingleLineDelimitedCommentChars SingleLineHTMLOpenComment :: <!-- SingleLineCommentCharsopt SingleLineHTMLCloseComment :: LineTerminatorSequence HTMLCloseComment SingleLineDelimitedComment :: /* SingleLineDelimitedCommentCharsopt */ HTMLCloseComment :: WhiteSpaceSequenceopt SingleLineDelimitedCommentSequenceopt --> SingleLineCommentCharsopt SingleLineDelimitedCommentChars :: SingleLineNotAsteriskChar SingleLineDelimitedCommentCharsopt * SingleLinePostAsteriskCommentCharsopt SingleLineNotAsteriskChar :: SourceCharacter but not one of * or LineTerminator SingleLinePostAsteriskCommentChars :: SingleLineNotForwardSlashOrAsteriskChar SingleLineDelimitedCommentCharsopt * SingleLinePostAsteriskCommentCharsopt SingleLineNotForwardSlashOrAsteriskChar :: SourceCharacter but not one of / or * or LineTerminator WhiteSpaceSequence :: WhiteSpace WhiteSpaceSequenceopt SingleLineDelimitedCommentSequence :: SingleLineDelimitedComment WhiteSpaceSequenceopt SingleLineDelimitedCommentSequenceopt

Similar to a MultiLineComment that contains a line terminator code point, a SingleLineHTMLCloseComment is considered to be a LineTerminator for purposes of parsing by the syntactic grammar.

B.1.2 Regular Expressions Patterns

The syntax of 22.2.1 is modified and extended as follows. These changes introduce ambiguities that are broken by the ordering of grammar productions and by contextual information. When parsing using the following grammar, each alternative is considered only if previous production alternatives do not match.

This alternative pattern grammar and semantics only changes the syntax and semantics of BMP patterns. The following grammar extensions include productions parameterized with the [UnicodeMode] parameter. However, none of these extensions change the syntax of Unicode patterns recognized when parsing with the [UnicodeMode] parameter present on the goal symbol.

Syntax

Term[UnicodeMode, UnicodeSetsMode, NamedCaptureGroups] :: [+UnicodeMode] Assertion[+UnicodeMode, ?UnicodeSetsMode, ?NamedCaptureGroups] [+UnicodeMode] Atom[+UnicodeMode, ?UnicodeSetsMode, ?NamedCaptureGroups] Quantifier [+UnicodeMode] Atom[+UnicodeMode, ?UnicodeSetsMode, ?NamedCaptureGroups] [~UnicodeMode] QuantifiableAssertion[?NamedCaptureGroups] Quantifier [~UnicodeMode] Assertion[~UnicodeMode, ~UnicodeSetsMode, ?NamedCaptureGroups] [~UnicodeMode] ExtendedAtom[?NamedCaptureGroups] Quantifier [~UnicodeMode] ExtendedAtom[?NamedCaptureGroups] Assertion[UnicodeMode, UnicodeSetsMode, NamedCaptureGroups] :: ^ $ \b \B [+UnicodeMode] (?= Disjunction[+UnicodeMode, ?UnicodeSetsMode, ?NamedCaptureGroups] ) [+UnicodeMode] (?! Disjunction[+UnicodeMode, ?UnicodeSetsMode, ?NamedCaptureGroups] ) [~UnicodeMode] QuantifiableAssertion[?NamedCaptureGroups] (?<= Disjunction[?UnicodeMode, ?UnicodeSetsMode, ?NamedCaptureGroups] ) (?<! Disjunction[?UnicodeMode, ?UnicodeSetsMode, ?NamedCaptureGroups] ) QuantifiableAssertion[NamedCaptureGroups] :: (?= Disjunction[~UnicodeMode, ~UnicodeSetsMode, ?NamedCaptureGroups] ) (?! Disjunction[~UnicodeMode, ~UnicodeSetsMode, ?NamedCaptureGroups] ) ExtendedAtom[NamedCaptureGroups] :: . \ AtomEscape[~UnicodeMode, ?NamedCaptureGroups] \ [lookahead = c] CharacterClass[~UnicodeMode, ~UnicodeSetsMode] ( GroupSpecifier[~UnicodeMode]opt Disjunction[~UnicodeMode, ~UnicodeSetsMode, ?NamedCaptureGroups] ) (? RegularExpressionModifiers : Disjunction[~UnicodeMode, ~UnicodeSetsMode, ?NamedCaptureGroups] ) (? RegularExpressionModifiers - RegularExpressionModifiers : Disjunction[~UnicodeMode, ~UnicodeSetsMode, ?NamedCaptureGroups] ) InvalidBracedQuantifier ExtendedPatternCharacter InvalidBracedQuantifier :: { DecimalDigits[~Sep] } { DecimalDigits[~Sep] ,} { DecimalDigits[~Sep] , DecimalDigits[~Sep] } ExtendedPatternCharacter :: SourceCharacter but not one of ^ $ \ . * + ? ( ) [ | AtomEscape[UnicodeMode, NamedCaptureGroups] :: [+UnicodeMode] DecimalEscape [~UnicodeMode] DecimalEscape but only if the CapturingGroupNumber of DecimalEscape is ≤ CountLeftCapturingParensWithin(the Pattern containing DecimalEscape) CharacterClassEscape[?UnicodeMode] CharacterEscape[?UnicodeMode, ?NamedCaptureGroups] [+NamedCaptureGroups] k GroupName[?UnicodeMode] CharacterEscape[UnicodeMode, NamedCaptureGroups] :: ControlEscape c AsciiLetter 0 [lookahead ∉ DecimalDigit] HexEscapeSequence RegExpUnicodeEscapeSequence[?UnicodeMode] [~UnicodeMode] LegacyOctalEscapeSequence IdentityEscape[?UnicodeMode, ?NamedCaptureGroups] IdentityEscape[UnicodeMode, NamedCaptureGroups] :: [+UnicodeMode] SyntaxCharacter [+UnicodeMode] / [~UnicodeMode] SourceCharacterIdentityEscape[?NamedCaptureGroups] SourceCharacterIdentityEscape[NamedCaptureGroups] :: [~NamedCaptureGroups] SourceCharacter but not c [+NamedCaptureGroups] SourceCharacter but not one of c or k ClassAtomNoDash[UnicodeMode, NamedCaptureGroups] :: SourceCharacter but not one of \ or ] or - \ ClassEscape[?UnicodeMode, ?NamedCaptureGroups] \ [lookahead = c] ClassEscape[UnicodeMode, NamedCaptureGroups] :: b [+UnicodeMode] - [~UnicodeMode] c ClassControlLetter CharacterClassEscape[?UnicodeMode] CharacterEscape[?UnicodeMode, ?NamedCaptureGroups] ClassControlLetter :: DecimalDigit _ Note

When the same left-hand sides occurs with both [+UnicodeMode] and [~UnicodeMode] guards it is to control the disambiguation priority.

B.1.2.1 Static Semantics: Early Errors

The semantics of 22.2.1.1 is extended as follows:

ExtendedAtom :: InvalidBracedQuantifier
  • It is a Syntax Error if any source text is matched by this production.

Additionally, the rules for the following productions are modified with the addition of the highlighted text:

NonemptyClassRanges :: ClassAtom - ClassAtom ClassContents NonemptyClassRangesNoDash :: ClassAtomNoDash - ClassAtom ClassContents

B.1.2.2 Static Semantics: CountLeftCapturingParensWithin and CountLeftCapturingParensBefore

In the definitions of CountLeftCapturingParensWithin and CountLeftCapturingParensBefore, references to “ Atom :: ( GroupSpecifieropt Disjunction ) ” are to be interpreted as meaning “ Atom :: ( GroupSpecifieropt Disjunction ) ” or “ ExtendedAtom :: ( GroupSpecifieropt Disjunction ) ”.

B.1.2.3 Static Semantics: IsCharacterClass

The semantics of 22.2.1.6 is extended as follows:

ClassAtomNoDash :: \ [lookahead = c]
  1. Return false.

B.1.2.4 Static Semantics: CharacterValue

The semantics of 22.2.1.7 is extended as follows:

ClassAtomNoDash :: \ [lookahead = c]
  1. Return the numeric value of U+005C (REVERSE SOLIDUS).
ClassEscape :: c ClassControlLetter
  1. Let ch be the code point matched by ClassControlLetter.
  2. Let i be the numeric value of ch.
  3. Return the remainder of dividing i by 32.
CharacterEscape :: LegacyOctalEscapeSequence
  1. Return the MV of LegacyOctalEscapeSequence (see 12.9.4.3).

B.1.2.5 Runtime Semantics: CompileSubpattern

The semantics of CompileSubpattern is extended as follows:

The rule for Term :: QuantifiableAssertion Quantifier is the same as for Term :: Atom Quantifier but with QuantifiableAssertion substituted for Atom.

The rule for Term :: ExtendedAtom Quantifier is the same as for Term :: Atom Quantifier but with ExtendedAtom substituted for Atom.

The rule for Term :: ExtendedAtom is the same as for Term :: Atom but with ExtendedAtom substituted for Atom.

B.1.2.6 Runtime Semantics: CompileAssertion

CompileAssertion rules for the Assertion :: (?= Disjunction ) and Assertion :: (?! Disjunction ) productions are also used for the QuantifiableAssertion productions, but with QuantifiableAssertion substituted for Assertion.

B.1.2.7 Runtime Semantics: CompileAtom

CompileAtom rules for the Atom productions except for Atom :: PatternCharacter are also used for the ExtendedAtom productions, but with ExtendedAtom substituted for Atom. The following rules, with parameter direction, are also added:

ExtendedAtom :: \ [lookahead = c]
  1. Let A be the CharSet containing the single character \ U+005C (REVERSE SOLIDUS).
  2. Return CharacterSetMatcher(rer, A, false, direction).
ExtendedAtom :: ExtendedPatternCharacter
  1. Let ch be the character represented by ExtendedPatternCharacter.
  2. Let A be a one-element CharSet containing the character ch.
  3. Return CharacterSetMatcher(rer, A, false, direction).

B.1.2.8 Runtime Semantics: CompileToCharSet

The semantics of 22.2.2.9 is extended as follows:

The following two rules replace the corresponding rules of CompileToCharSet.

NonemptyClassRanges :: ClassAtom - ClassAtom ClassContents
  1. Let A be CompileToCharSet of the first ClassAtom with argument rer.
  2. Let B be CompileToCharSet of the second ClassAtom with argument rer.
  3. Let C be CompileToCharSet of ClassContents with argument rer.
  4. Let D be CharacterRangeOrUnion(rer, A, B).
  5. Return the union of D and C.
NonemptyClassRangesNoDash :: ClassAtomNoDash - ClassAtom ClassContents
  1. Let A be CompileToCharSet of ClassAtomNoDash with argument rer.
  2. Let B be CompileToCharSet of ClassAtom with argument rer.
  3. Let C be CompileToCharSet of ClassContents with argument rer.
  4. Let D be CharacterRangeOrUnion(rer, A, B).
  5. Return the union of D and C.

In addition, the following rules are added to CompileToCharSet.

ClassEscape :: c ClassControlLetter
  1. Let cv be the CharacterValue of this ClassEscape.
  2. Let c be the character whose character value is cv.
  3. Return the CharSet containing the single character c.
ClassAtomNoDash :: \ [lookahead = c]
  1. Return the CharSet containing the single character \ U+005C (REVERSE SOLIDUS).
Note
This production can only be reached from the sequence \c within a character class where it is not followed by an acceptable control character.

B.1.2.8.1 CharacterRangeOrUnion ( rer, A, B )

The abstract operation CharacterRangeOrUnion takes arguments rer (a RegExp Record), A (a CharSet), and B (a CharSet) and returns a CharSet. It performs the following steps when called:

  1. If HasEitherUnicodeFlag(rer) is false, then
    1. If A does not contain exactly one character or B does not contain exactly one character, then
      1. Let C be the CharSet containing the single character - U+002D (HYPHEN-MINUS).
      2. Return the union of CharSets A, B and C.
  2. Return CharacterRange(A, B).

B.1.2.9 Static Semantics: ParsePattern ( patternText, u, v )

The semantics of 22.2.3.4 is extended as follows:

The abstract operation ParsePattern takes arguments patternText (a sequence of Unicode code points), u (a Boolean), and v (a Boolean). It performs the following steps when called:

  1. If v is true and u is true, then
    1. Let parseResult be a List containing one or more SyntaxError objects.
  2. Else if v is true, then
    1. Let parseResult be ParseText(patternText, Pattern[+UnicodeMode, +UnicodeSetsMode, +NamedCaptureGroups]).
  3. Else if u is true, then
    1. Let parseResult be ParseText(patternText, Pattern[+UnicodeMode, ~UnicodeSetsMode, +NamedCaptureGroups]).
  4. Else,
    1. Let parseResult be ParseText(patternText, Pattern[~UnicodeMode, ~UnicodeSetsMode, ~NamedCaptureGroups]).
    2. If parseResult is a Parse Node and parseResult contains a GroupName, then
      1. Set parseResult to ParseText(patternText, Pattern[~UnicodeMode, ~UnicodeSetsMode, +NamedCaptureGroups]).
  5. Return parseResult.

B.2 Additional Built-in Properties

When the ECMAScript host is a web browser the following additional properties of the standard built-in objects are defined.

B.2.1 Additional Properties of the Global Object

The entries in Table 102 are added to Table 6.

Table 102: Additional Well-known Intrinsic Objects
Intrinsic Name Global Name ECMAScript Language Association
%escape% escape The escape function (B.2.1.1)
%unescape% unescape The unescape function (B.2.1.2)

B.2.1.1 escape ( string )

This function is a property of the global object. It computes a new version of a String value in which certain code units have been replaced by a hexadecimal escape sequence.

When replacing a code unit of numeric value less than or equal to 0x00FF, a two-digit escape sequence of the form %xx is used. When replacing a code unit of numeric value strictly greater than 0x00FF, a four-digit escape sequence of the form %uxxxx is used.

It is the %escape% intrinsic object.

It performs the following steps when called:

  1. Set string to ? ToString(string).
  2. Let len be the length of string.
  3. Let R be the empty String.
  4. Let unescapedSet be the string-concatenation of the ASCII word characters and "@*+-./".
  5. Let k be 0.
  6. Repeat, while k < len,
    1. Let C be the code unit at index k within string.
    2. If unescapedSet contains C, then
      1. Let S be C.
    3. Else,
      1. Let n be the numeric value of C.
      2. If n < 256, then
        1. Let hex be the String representation of n, formatted as an uppercase hexadecimal number.
        2. Let S be the string-concatenation of "%" and StringPad(hex, 2, "0", start).
      3. Else,
        1. Let hex be the String representation of n, formatted as an uppercase hexadecimal number.
        2. Let S be the string-concatenation of "%u" and StringPad(hex, 4, "0", start).
    4. Set R to the string-concatenation of R and S.
    5. Set k to k + 1.
  7. Return R.
Note

The encoding is partly based on the encoding described in RFC 1738, but the entire encoding specified in this standard is described above without regard to the contents of RFC 1738. This encoding does not reflect changes to RFC 1738 made by RFC 3986.

B.2.1.2 unescape ( string )

This function is a property of the global object. It computes a new version of a String value in which each escape sequence of the sort that might be introduced by the escape function is replaced with the code unit that it represents.

It is the %unescape% intrinsic object.

It performs the following steps when called:

  1. Set string to ? ToString(string).
  2. Let len be the length of string.
  3. Let R be the empty String.
  4. Let k be 0.
  5. Repeat, while k < len,
    1. Let C be the code unit at index k within string.
    2. If C is the code unit 0x0025 (PERCENT SIGN), then
      1. Let hexDigits be the empty String.
      2. Let optionalAdvance be 0.
      3. If k + 5 < len and the code unit at index k + 1 within string is the code unit 0x0075 (LATIN SMALL LETTER U), then
        1. Set hexDigits to the substring of string from k + 2 to k + 6.
        2. Set optionalAdvance to 5.
      4. Else if k + 3 ≤ len, then
        1. Set hexDigits to the substring of string from k + 1 to k + 3.
        2. Set optionalAdvance to 2.
      5. Let parseResult be ParseText(hexDigits, HexDigits[~Sep]).
      6. If parseResult is a Parse Node, then
        1. Let n be the MV of parseResult.
        2. Set C to the code unit whose numeric value is n.
        3. Set k to k + optionalAdvance.
    3. Set R to the string-concatenation of R and C.
    4. Set k to k + 1.
  6. Return R.

B.2.2 Additional Properties of the String.prototype Object

B.2.2.1 String.prototype.substr ( start, length )

This method returns a substring of the result of converting the this value to a String, starting from index start and running for length code units (or through the end of the String if length is undefined). If start is negative, it is treated as sourceLength + start where sourceLength is the length of the String. The result is a String value, not a String object.

It performs the following steps when called:

  1. Let O be ? RequireObjectCoercible(this value).
  2. Let S be ? ToString(O).
  3. Let size be the length of S.
  4. Let intStart be ? ToIntegerOrInfinity(start).
  5. If intStart = -∞, set intStart to 0.
  6. Else if intStart < 0, set intStart to max(size + intStart, 0).
  7. Else, set intStart to min(intStart, size).
  8. If length is undefined, let intLength be size; otherwise let intLength be ? ToIntegerOrInfinity(length).
  9. Set intLength to the result of clamping intLength between 0 and size.
  10. Let intEnd be min(intStart + intLength, size).
  11. Return the substring of S from intStart to intEnd.
Note

This method is intentionally generic; it does not require that its this value be a String object. Therefore it can be transferred to other kinds of objects for use as a method.

B.2.2.2 String.prototype.anchor ( name )

This method performs the following steps when called:

  1. Let S be the this value.
  2. Return ? CreateHTML(S, "a", "name", name).

B.2.2.2.1 CreateHTML ( string, tag, attribute, value )

The abstract operation CreateHTML takes arguments string (an ECMAScript language value), tag (a String), attribute (a String), and value (an ECMAScript language value) and returns either a normal completion containing a String or a throw completion. It performs the following steps when called:

  1. Let str be ? RequireObjectCoercible(string).
  2. Let S be ? ToString(str).
  3. Let p1 be the string-concatenation of "<" and tag.
  4. If attribute is not the empty String, then
    1. Let V be ? ToString(value).
    2. Let escapedV be the String value that is the same as V except that each occurrence of the code unit 0x0022 (QUOTATION MARK) in V has been replaced with the six code unit sequence "&quot;".
    3. Set p1 to the string-concatenation of:
      • p1
      • the code unit 0x0020 (SPACE)
      • attribute
      • the code unit 0x003D (EQUALS SIGN)
      • the code unit 0x0022 (QUOTATION MARK)
      • escapedV
      • the code unit 0x0022 (QUOTATION MARK)
  5. Let p2 be the string-concatenation of p1 and ">".
  6. Let p3 be the string-concatenation of p2 and S.
  7. Let p4 be the string-concatenation of p3, "</", tag, and ">".
  8. Return p4.

B.2.2.3 String.prototype.big ( )

This method performs the following steps when called:

  1. Let S be the this value.
  2. Return ? CreateHTML(S, "big", "", "").

B.2.2.4 String.prototype.blink ( )

This method performs the following steps when called:

  1. Let S be the this value.
  2. Return ? CreateHTML(S, "blink", "", "").

B.2.2.5 String.prototype.bold ( )

This method performs the following steps when called:

  1. Let S be the this value.
  2. Return ? CreateHTML(S, "b", "", "").

B.2.2.6 String.prototype.fixed ( )

This method performs the following steps when called:

  1. Let S be the this value.
  2. Return ? CreateHTML(S, "tt", "", "").

B.2.2.7 String.prototype.fontcolor ( colour )

This method performs the following steps when called:

  1. Let S be the this value.
  2. Return ? CreateHTML(S, "font", "color", colour).

B.2.2.8 String.prototype.fontsize ( size )

This method performs the following steps when called:

  1. Let S be the this value.
  2. Return ? CreateHTML(S, "font", "size", size).

B.2.2.9 String.prototype.italics ( )

This method performs the following steps when called:

  1. Let S be the this value.
  2. Return ? CreateHTML(S, "i", "", "").

B.2.2.10 String.prototype.link ( url )

This method performs the following steps when called:

  1. Let S be the this value.
  2. Return ? CreateHTML(S, "a", "href", url).

B.2.2.11 String.prototype.small ( )

This method performs the following steps when called:

  1. Let S be the this value.
  2. Return ? CreateHTML(S, "small", "", "").

B.2.2.12 String.prototype.strike ( )

This method performs the following steps when called:

  1. Let S be the this value.
  2. Return ? CreateHTML(S, "strike", "", "").

B.2.2.13 String.prototype.sub ( )

This method performs the following steps when called:

  1. Let S be the this value.
  2. Return ? CreateHTML(S, "sub", "", "").

B.2.2.14 String.prototype.sup ( )

This method performs the following steps when called:

  1. Let S be the this value.
  2. Return ? CreateHTML(S, "sup", "", "").

B.2.2.15 String.prototype.trimLeft ( )

Note

The property "trimStart" is preferred. The "trimLeft" property is provided principally for compatibility with old code. It is recommended that the "trimStart" property be used in new ECMAScript code.

The initial value of the "trimLeft" property is %String.prototype.trimStart%, defined in 22.1.3.34.

B.2.2.16 String.prototype.trimRight ( )

Note

The property "trimEnd" is preferred. The "trimRight" property is provided principally for compatibility with old code. It is recommended that the "trimEnd" property be used in new ECMAScript code.

The initial value of the "trimRight" property is %String.prototype.trimEnd%, defined in 22.1.3.33.

B.2.3 Additional Properties of the Date.prototype Object

B.2.3.1 Date.prototype.getYear ( )

Note

The getFullYear method is preferred for nearly all purposes, because it avoids the “year 2000 problem.”

This method performs the following steps when called:

  1. Let dateObject be the this value.
  2. Perform ? RequireInternalSlot(dateObject, [[DateValue]]).
  3. Let t be dateObject.[[DateValue]].
  4. If t is NaN, return NaN.
  5. Return YearFromTime(LocalTime(t)) - 1900𝔽.

B.2.3.2 Date.prototype.setYear ( year )

Note

The setFullYear method is preferred for nearly all purposes, because it avoids the “year 2000 problem.”

This method performs the following steps when called:

  1. Let dateObject be the this value.
  2. Perform ? RequireInternalSlot(dateObject, [[DateValue]]).
  3. Let t be dateObject.[[DateValue]].
  4. Let y be ? ToNumber(year).
  5. If t is NaN, set t to +0𝔽; otherwise set t to LocalTime(t).
  6. Let yyyy be MakeFullYear(y).
  7. Let d be MakeDay(yyyy, MonthFromTime(t), DateFromTime(t)).
  8. Let date be MakeDate(d, TimeWithinDay(t)).
  9. Let u be TimeClip(UTC(date)).
  10. Set dateObject.[[DateValue]] to u.
  11. Return u.

B.2.3.3 Date.prototype.toGMTString ( )

Note

The toUTCString method is preferred. This method is provided principally for compatibility with old code.

The initial value of the "toGMTString" property is %Date.prototype.toUTCString%, defined in 21.4.4.43.

B.2.4 Additional Properties of the RegExp.prototype Object

B.2.4.1 RegExp.prototype.compile ( pattern, flags )

This method performs the following steps when called:

  1. Let O be the this value.
  2. Perform ? RequireInternalSlot(O, [[RegExpMatcher]]).
  3. If pattern is an Object and pattern has a [[RegExpMatcher]] internal slot, then
    1. If flags is not undefined, throw a TypeError exception.
    2. Let P be pattern.[[OriginalSource]].
    3. Let F be pattern.[[OriginalFlags]].
  4. Else,
    1. Let P be pattern.
    2. Let F be flags.
  5. Return ? RegExpInitialize(O, P, F).
Note

This method completely reinitializes the this value RegExp with a new pattern and flags. An implementation may interpret use of this method as an assertion that the resulting RegExp object will be used multiple times and hence is a candidate for extra optimization.

B.3 Other Additional Features

B.3.1 Labelled Function Declarations

Prior to ECMAScript 2015, the specification of LabelledStatement did not allow for the association of a statement label with a FunctionDeclaration. However, a labelled FunctionDeclaration was an allowable extension for non-strict code and most browser-hosted ECMAScript implementations supported that extension. In ECMAScript 2015 and later, the grammar production for LabelledStatement permits use of FunctionDeclaration as a LabelledItem but 14.13.1 includes an Early Error rule that produces a Syntax Error if that occurs. That rule is modified with the addition of the highlighted text:

LabelledItem : FunctionDeclaration
  • It is a Syntax Error if any source text that is strict mode code is matched by this production.
Note

The early error rules for WithStatement, IfStatement, and IterationStatement prevent these statements from containing a labelled FunctionDeclaration in non-strict code.

B.3.2 Block-Level Function Declarations Web Legacy Compatibility Semantics

Prior to ECMAScript 2015, the ECMAScript specification did not define the occurrence of a FunctionDeclaration as an element of a Block statement's StatementList. However, support for that form of FunctionDeclaration was an allowable extension and most browser-hosted ECMAScript implementations permitted them. Unfortunately, the semantics of such declarations differ among those implementations. Because of these semantic differences, existing web ECMAScript source text that uses Block level function declarations is only portable among browser implementations if the usage only depends upon the semantic intersection of all of the browser implementations for such declarations. The following are the use cases that fall within that intersection semantics:

  1. A function is declared and only referenced within a single block.

    • One or more FunctionDeclarations whose BindingIdentifier is the name f occur within the function code of an enclosing function g and that declaration is nested within a Block.
    • No other declaration of f that is not a var declaration occurs within the function code of g.
    • All occurrences of f as an IdentifierReference are within the StatementList of the Block containing the declaration of f.
  2. A function is declared and possibly used within a single Block but also referenced by an inner function definition that is not contained within that same Block.

    • One or more FunctionDeclarations whose BindingIdentifier is the name f occur within the function code of an enclosing function g and that declaration is nested within a Block.
    • No other declaration of f that is not a var declaration occurs within the function code of g.
    • There may be occurrences of f as an IdentifierReference within the StatementList of the Block containing the declaration of f.
    • There is at least one occurrence of f as an IdentifierReference within another function h that is nested within g and no other declaration of f shadows the references to f from within h.
    • All invocations of h occur after the declaration of f has been evaluated.
  3. A function is declared and possibly used within a single block but also referenced within subsequent blocks.

    • One or more FunctionDeclaration whose BindingIdentifier is the name f occur within the function code of an enclosing function g and that declaration is nested within a Block.
    • No other declaration of f that is not a var declaration occurs within the function code of g.
    • There may be occurrences of f as an IdentifierReference within the StatementList of the Block containing the declaration of f.
    • There is at least one occurrence of f as an IdentifierReference within the function code of g that lexically follows the Block containing the declaration of f.

The first use case is interoperable with the semantics of Block level function declarations provided by ECMAScript 2015. Any pre-existing ECMAScript source text that employs that use case will operate using the Block level function declarations semantics defined by clauses 10, 14, and 15.

ECMAScript 2015 interoperability for the second and third use cases requires the following extensions to the clause 10, clause 15, clause 19.2.1 and clause 16.1.7 semantics.

If an ECMAScript implementation has a mechanism for reporting diagnostic warning messages, a warning should be produced when code contains a FunctionDeclaration for which these compatibility semantics are applied and introduce observable differences from non-compatibility semantics. For example, if a var binding is not introduced because its introduction would create an early error, a warning message should not be produced.

B.3.2.1 Changes to FunctionDeclarationInstantiation

During FunctionDeclarationInstantiation the following steps are performed in place of step 31:

  1. If strict is false, then
    1. For each FunctionDeclaration f that is directly contained in the StatementList of any Block, CaseClause, or DefaultClause x such that code Contains x is true, do
      1. Let F be the StringValue of the BindingIdentifier of f.
      2. If replacing the FunctionDeclaration f with a VariableStatement that has F as a BindingIdentifier would not produce any Early Errors for func and parameterNames does not contain F, then
        1. NOTE: A var binding for F is only instantiated here if it is neither a VarDeclaredName, the name of a formal parameter, or another FunctionDeclaration.
        2. If instantiatedVarNames does not contain F and F is not "arguments", then
          1. Perform ! varEnv.CreateMutableBinding(F, false).
          2. Perform ! varEnv.InitializeBinding(F, undefined).
          3. Append F to instantiatedVarNames.
        3. When the FunctionDeclaration f is evaluated, perform the following steps in place of the FunctionDeclaration Evaluation algorithm provided in 15.2.6:
          1. Let fEnv be the running execution context's VariableEnvironment.
          2. Let bEnv be the running execution context's LexicalEnvironment.
          3. Let fObj be ! bEnv.GetBindingValue(F, false).
          4. Perform ! fEnv.SetMutableBinding(F, fObj, false).
          5. Return unused.

B.3.2.2 Changes to GlobalDeclarationInstantiation

During GlobalDeclarationInstantiation the following steps are performed in place of step 12:

  1. Perform the following steps:
    1. Let strict be ScriptIsStrict of script.
    2. If strict is false, then
      1. Let declaredFunctionOrVarNames be the list-concatenation of declaredFunctionNames and declaredVarNames.
      2. For each FunctionDeclaration f that is directly contained in the StatementList of any Block, CaseClause, or DefaultClause x such that script Contains x is true, do
        1. Let F be the StringValue of the BindingIdentifier of f.
        2. If replacing the FunctionDeclaration f with a VariableStatement that has F as a BindingIdentifier would not produce any Early Errors for script, then
          1. If HasLexicalDeclaration(env, F) is false, then
            1. Let fnDefinable be ? CanDeclareGlobalVar(env, F).
            2. If fnDefinable is true, then
              1. NOTE: A var binding for F is only instantiated here if it is neither a VarDeclaredName nor the name of another FunctionDeclaration.
              2. If declaredFunctionOrVarNames does not contain F, then
                1. Perform ? CreateGlobalVarBinding(env, F, false).
                2. Append F to declaredFunctionOrVarNames.
              3. When the FunctionDeclaration f is evaluated, perform the following steps in place of the FunctionDeclaration Evaluation algorithm provided in 15.2.6:
                1. Let gEnv be the running execution context's VariableEnvironment.
                2. Let bEnv be the running execution context's LexicalEnvironment.
                3. Let fObj be ! bEnv.GetBindingValue(F, false).
                4. Perform ? gEnv.SetMutableBinding(F, fObj, false).
                5. Return unused.

B.3.2.3 Changes to EvalDeclarationInstantiation

During EvalDeclarationInstantiation the following steps are performed in place of step 13:

  1. If strict is false, then
    1. Let declaredFunctionOrVarNames be the list-concatenation of declaredFunctionNames and declaredVarNames.
    2. For each FunctionDeclaration f that is directly contained in the StatementList of any Block, CaseClause, or DefaultClause x such that body Contains x is true, do
      1. Let F be the StringValue of the BindingIdentifier of f.
      2. If replacing the FunctionDeclaration f with a VariableStatement that has F as a BindingIdentifier would not produce any Early Errors for body, then
        1. Let bindingExists be false.
        2. Let thisEnv be lexEnv.
        3. Assert: The following loop will terminate.
        4. Repeat, while thisEnv is not varEnv,
          1. If thisEnv is not an Object Environment Record, then
            1. If ! thisEnv.HasBinding(F) is true, then
              1. Let bindingExists be true.
          2. Set thisEnv to thisEnv.[[OuterEnv]].
        5. If bindingExists is false and varEnv is a Global Environment Record, then
          1. If HasLexicalDeclaration(varEnv, F) is false, then
            1. Let fnDefinable be ? CanDeclareGlobalVar(varEnv, F).
          2. Else,
            1. Let fnDefinable be false.
        6. Else,
          1. Let fnDefinable be true.
        7. If bindingExists is false and fnDefinable is true, then
          1. If declaredFunctionOrVarNames does not contain F, then
            1. If varEnv is a Global Environment Record, then
              1. Perform ? CreateGlobalVarBinding(varEnv, F, true).
            2. Else,
              1. Let bindingExists be ! varEnv.HasBinding(F).
              2. If bindingExists is false, then
                1. Perform ! varEnv.CreateMutableBinding(F, true).
                2. Perform ! varEnv.InitializeBinding(F, undefined).
            3. Append F to declaredFunctionOrVarNames.
          2. When the FunctionDeclaration f is evaluated, perform the following steps in place of the FunctionDeclaration Evaluation algorithm provided in 15.2.6:
            1. Let gEnv be the running execution context's VariableEnvironment.
            2. Let bEnv be the running execution context's LexicalEnvironment.
            3. Let fObj be ! bEnv.GetBindingValue(F, false).
            4. Perform ? gEnv.SetMutableBinding(F, fObj, false).
            5. Return unused.

B.3.2.4 Changes to Block Static Semantics: Early Errors

The rules for the following production in 14.2.1 are modified with the addition of the highlighted text:

Block : { StatementList }

B.3.2.5 Changes to switch Statement Static Semantics: Early Errors

The rules for the following production in 14.12.1 are modified with the addition of the highlighted text:

SwitchStatement : switch ( Expression ) CaseBlock

B.3.2.6 Changes to BlockDeclarationInstantiation

During BlockDeclarationInstantiation the following steps are performed in place of step 3.a.ii.1:

  1. If ! env.HasBinding(dn) is false, then
    1. Perform ! env.CreateMutableBinding(dn, false).

During BlockDeclarationInstantiation the following steps are performed in place of step 3.b.iii:

  1. Perform the following steps:
    1. If the binding for fn in env is an uninitialized binding, then
      1. Perform ! env.InitializeBinding(fn, fo).
    2. Else,
      1. Assert: d is a FunctionDeclaration.
      2. Perform ! env.SetMutableBinding(fn, fo, false).

B.3.3 FunctionDeclarations in IfStatement Statement Clauses

The following augments the IfStatement production in 14.6:

IfStatement[Yield, Await, Return] : if ( Expression[+In, ?Yield, ?Await] ) FunctionDeclaration[?Yield, ?Await, ~Default] else Statement[?Yield, ?Await, ?Return] if ( Expression[+In, ?Yield, ?Await] ) Statement[?Yield, ?Await, ?Return] else FunctionDeclaration[?Yield, ?Await, ~Default] if ( Expression[+In, ?Yield, ?Await] ) FunctionDeclaration[?Yield, ?Await, ~Default] else FunctionDeclaration[?Yield, ?Await, ~Default] if ( Expression[+In, ?Yield, ?Await] ) FunctionDeclaration[?Yield, ?Await, ~Default] [lookahead ≠ else]

This production only applies when parsing non-strict code. Source text matched by this production is processed as if each matching occurrence of FunctionDeclaration[?Yield, ?Await, ~Default] was the sole StatementListItem of a BlockStatement occupying that position in the source text. The semantics of such a synthetic BlockStatement includes the web legacy compatibility semantics specified in B.3.2.

B.3.4 VariableStatements in Catch Blocks

The content of subclause 14.15.1 is replaced with the following:

Catch : catch ( CatchParameter ) Block Note

The Block of a Catch clause may contain var declarations that bind a name that is also bound by the CatchParameter. At runtime, such bindings are instantiated in the VariableDeclarationEnvironment. They do not shadow the same-named bindings introduced by the CatchParameter and hence the Initializer for such var declarations will assign to the corresponding catch parameter rather than the var binding.

This modified behaviour also applies to var and function declarations introduced by direct eval calls contained within the Block of a Catch clause. This change is accomplished by modifying the algorithm of 19.2.1.3 as follows:

Step 3.d.i.2.a.i is replaced by:

  1. If thisEnv is not the Environment Record for a Catch clause, throw a SyntaxError exception.

Step 13.b.ii.4.a.i.i is replaced by:

  1. If thisEnv is not the Environment Record for a Catch clause, let bindingExists be true.

B.3.5 Initializers in ForIn Statement Heads

The following augments the ForInOfStatement production in 14.7.5:

ForInOfStatement[Yield, Await, Return] : for ( var BindingIdentifier[?Yield, ?Await] Initializer[~In, ?Yield, ?Await] in Expression[+In, ?Yield, ?Await] ) Statement[?Yield, ?Await, ?Return]

This production only applies when parsing non-strict code.

The static semantics of ContainsDuplicateLabels in 8.3.1 are augmented with the following:

ForInOfStatement : for ( var BindingIdentifier Initializer in Expression ) Statement
  1. Return ContainsDuplicateLabels of Statement with argument labelSet.

The static semantics of ContainsUndefinedBreakTarget in 8.3.2 are augmented with the following:

ForInOfStatement : for ( var BindingIdentifier Initializer in Expression ) Statement
  1. Return ContainsUndefinedBreakTarget of Statement with argument labelSet.

The static semantics of ContainsUndefinedContinueTarget in 8.3.3 are augmented with the following:

ForInOfStatement : for ( var BindingIdentifier Initializer in Expression ) Statement
  1. Return ContainsUndefinedContinueTarget of Statement with arguments iterationSet and « ».

The static semantics of IsDestructuring in 14.7.5.2 are augmented with the following:

BindingIdentifier : Identifier yield await
  1. Return false.

The static semantics of VarDeclaredNames in 8.2.6 are augmented with the following:

ForInOfStatement : for ( var BindingIdentifier Initializer in Expression ) Statement
  1. Let names1 be the BoundNames of BindingIdentifier.
  2. Let names2 be the VarDeclaredNames of Statement.
  3. Return the list-concatenation of names1 and names2.

The static semantics of VarScopedDeclarations in 8.2.7 are augmented with the following:

ForInOfStatement : for ( var BindingIdentifier Initializer in Expression ) Statement
  1. Let declarations1 be « BindingIdentifier ».
  2. Let declarations2 be the VarScopedDeclarations of Statement.
  3. Return the list-concatenation of declarations1 and declarations2.

The runtime semantics of ForInOfLoopEvaluation in 14.7.5.5 are augmented with the following:

ForInOfStatement : for ( var BindingIdentifier Initializer in Expression ) Statement
  1. Let bindingId be the StringValue of BindingIdentifier.
  2. Let lhs be ? ResolveBinding(bindingId).
  3. If IsAnonymousFunctionDefinition(Initializer) is true, then
    1. Let value be ? NamedEvaluation of Initializer with argument bindingId.
  4. Else,
    1. Let rhs be ? Evaluation of Initializer.
    2. Let value be ? GetValue(rhs).
  5. Perform ? PutValue(lhs, value).
  6. Let keyResult be ? ForIn/OfHeadEvaluation(« », Expression, enumerate).
  7. Return ? ForIn/OfBodyEvaluation(BindingIdentifier, Statement, keyResult, enumerate, var-binding, labelSet).

B.3.6 The [[IsHTMLDDA]] Internal Slot

An [[IsHTMLDDA]] internal slot may exist on host-defined objects. Objects with an [[IsHTMLDDA]] internal slot behave like undefined in the ToBoolean and IsLooselyEqual abstract operations and when used as an operand for the typeof operator.

Note

Objects with an [[IsHTMLDDA]] internal slot are never created by this specification. However, the document.all object in web browsers is a host-defined exotic object with this slot that exists for web compatibility purposes. There are no other known examples of this type of object and implementations should not create any with the exception of document.all.

B.3.6.1 Changes to ToBoolean

The following step replaces step 3 of ToBoolean:

  1. If argument is an Object and argument has an [[IsHTMLDDA]] internal slot, return false.

B.3.6.2 Changes to IsLooselyEqual

The following steps replace step 4 of IsLooselyEqual:

  1. Perform the following steps:
    1. If x is an Object, x has an [[IsHTMLDDA]] internal slot, and y is either undefined or null, return true.
    2. If x is either undefined or null, y is an Object, and y has an [[IsHTMLDDA]] internal slot, return true.

B.3.6.3 Changes to the typeof Operator

The following step replaces step 12 of the evaluation semantics for typeof:

  1. If val has an [[IsHTMLDDA]] internal slot, return "undefined".

B.3.7 Non-default behaviour in HostMakeJobCallback

The HostMakeJobCallback abstract operation allows hosts which are web browsers to specify non-default behaviour.

B.3.8 Non-default behaviour in HostEnsureCanAddPrivateElement

The HostEnsureCanAddPrivateElement abstract operation allows hosts which are web browsers to specify non-default behaviour.

B.3.9 Runtime Errors for Function Call Assignment Targets

When a function call (13.3.6) is used as an assignment target in non-strict code, instead of producing an early error, a ReferenceError exception is thrown during evaluation of the assignment.

Note

When the assignment target is the LeftHandSideExpression of an AssignmentExpression, the assignment operator must be = or an AssignmentOperator; in particular, the allowance here does not apply to the logical assignment operators (??=, &&=, ||=).

See step 1 of AssignmentTargetType for CallExpression : CoverCallExpressionAndAsyncArrowHead and CallExpression : CallExpression Arguments .

Annex C (informative) The Strict Mode of ECMAScript

The strict mode restriction and exceptions

Annex D (informative) Host Layering Points

See 4.2 for the definition of host.

D.1 Host Hooks

HostCallJobCallback(...)

HostEnqueueFinalizationRegistryCleanupJob(...)

HostEnqueueGenericJob(...)

HostEnqueuePromiseJob(...)

HostEnqueueTimeoutJob(...)

HostEnsureCanCompileStrings(...)

HostFinalizeImportMeta(...)

HostGetImportMetaProperties(...)

HostGrowSharedArrayBuffer(...)

HostHasSourceTextAvailable(...)

HostLoadImportedModule(...)

HostGetSupportedImportAttributes(...)

HostMakeJobCallback(...)

HostPromiseRejectionTracker(...)

HostResizeArrayBuffer(...)

InitializeHostDefinedRealm(...)

D.2 Host-defined Fields

[[HostDefined]] on Realm Records: See Table 24.

[[HostDefined]] on Script Records: See Table 39.

[[HostDefined]] on Module Records: See Table 43.

[[HostDefined]] on JobCallback Records: See Table 28.

[[HostSynchronizesWith]] on Candidate Executions: See Table 101.

[[IsHTMLDDA]]: See B.3.6.

D.3 Host-defined Objects

The global object: See clause 19.

D.4 Running Jobs

Preparation steps before, and cleanup steps after, invocation of Job Abstract Closures. See 9.5.

D.5 Internal Methods of Exotic Objects

Any of the essential internal methods in Table 4 for any exotic object not specified within this specification.

D.6 Built-in Objects and Methods

Any built-in objects and methods not defined within this specification, except as restricted in 17.1.

Annex E (informative) Corrections and Clarifications in ECMAScript 2015 with Possible Compatibility Impact

9.1.1.4.14-9.1.1.4.17 Edition 5 and 5.1 used a property existence test to determine whether a global object property corresponding to a new global declaration already existed. ECMAScript 2015 uses an own property existence test. This corresponds to what has been most commonly implemented by web browsers.

10.4.2.1: The 5th Edition moved the capture of the current array length prior to the integer conversion of the array index or new length value. However, the captured length value could become invalid if the conversion process has the side-effect of changing the array length. ECMAScript 2015 specifies that the current array length must be captured after the possible occurrence of such side-effects.

21.4.1.31: Previous editions permitted the TimeClip abstract operation to return either +0𝔽 or -0𝔽 as the representation of a 0 time value. ECMAScript 2015 specifies that +0𝔽 always returned. This means that for ECMAScript 2015 the time value of a Date is never observably -0𝔽 and methods that return time values never return -0𝔽.

21.4.1.32: If a UTC offset representation is not present, the local time zone is used. Edition 5.1 incorrectly stated that a missing time zone should be interpreted as "z".

21.4.4.36: If the year cannot be represented using the Date Time String Format specified in 21.4.1.32 a RangeError exception is thrown. Previous editions did not specify the behaviour for that case.

21.4.4.41: Previous editions did not specify the value returned by Date.prototype.toString when the time value is NaN. ECMAScript 2015 specifies the result to be the String value "Invalid Date".

22.2.4.1, 22.2.6.13.1: Any LineTerminator code points in the value of the "source" property of a RegExp instance must be expressed using an escape sequence. Edition 5.1 only required the escaping of /.

22.2.6.8, 22.2.6.11: In previous editions, the specifications for String.prototype.match and String.prototype.replace was incorrect for cases where the pattern argument was a RegExp value whose global flag is set. The previous specifications stated that for each attempt to match the pattern, if lastIndex did not change, it should be incremented by 1. The correct behaviour is that lastIndex should be incremented by 1 only if the pattern matched the empty String.

23.1.3.30: Previous editions did not specify how a NaN value returned by a comparator was interpreted by Array.prototype.sort. ECMAScript 2015 specifies that such as value is treated as if +0𝔽 was returned from the comparator. ECMAScript 2015 also specifies that ToNumber is applied to the result returned by a comparator. In previous editions, the effect of a comparator result that is not a Number value was implementation-defined. In practice, implementations call ToNumber.

Annex F (informative) Additions and Changes That Introduce Incompatibilities with Prior Editions

6.2.5: In ECMAScript 2015, Function calls are not allowed to return a Reference Record.

7.1.4.1: In ECMAScript 2015, ToNumber applied to a String value now recognizes and converts BinaryIntegerLiteral and OctalIntegerLiteral numeric strings. In previous editions such strings were converted to NaN.

9.3: In ECMAScript 2018, Template objects are canonicalized based on Parse Node (source location), instead of across all occurrences of that template literal or tagged template in a Realm in previous editions.

12.2: In ECMAScript 2016, Unicode 8.0.0 or higher is mandated, as opposed to ECMAScript 2015 which mandated Unicode 5.1. In particular, this caused U+180E MONGOLIAN VOWEL SEPARATOR, which was in the Space_Separator (Zs) category and thus treated as whitespace in ECMAScript 2015, to be moved to the Format (Cf) category (as of Unicode 6.3.0). This causes whitespace-sensitive methods to behave differently. For example, "\u180E".trim().length was 0 in previous editions, but 1 in ECMAScript 2016 and later. Additionally, ECMAScript 2017 mandated always using the latest version of the Unicode Standard.

12.7: In ECMAScript 2015, the valid code points for an IdentifierName are specified in terms of the Unicode properties “ID_Start” and “ID_Continue”. In previous editions, the valid IdentifierName or Identifier code points were specified by enumerating various Unicode code point categories.

12.10.1: In ECMAScript 2015, Automatic Semicolon Insertion adds a semicolon at the end of a do-while statement if the semicolon is missing. This change aligns the specification with the actual behaviour of most existing implementations.

13.2.5.1: In ECMAScript 2015, it is no longer an early error to have duplicate property names in Object Initializers.

13.15.1: In ECMAScript 2015, strict mode code containing an assignment to an immutable binding such as the function name of a FunctionExpression does not produce an early error. Instead it produces a runtime error.

14.2: In ECMAScript 2015, a StatementList beginning with the token let followed by the input elements LineTerminator then Identifier is the start of a LexicalDeclaration. In previous editions, automatic semicolon insertion would always insert a semicolon before the Identifier input element.

14.5: In ECMAScript 2015, a StatementListItem beginning with the token let followed by the token [ is the start of a LexicalDeclaration. In previous editions such a sequence would be the start of an ExpressionStatement.

14.6.2: In ECMAScript 2015, the normal result of an IfStatement is never the value empty. If no Statement part is evaluated or if the evaluated Statement part produces a normal completion containing empty, the result of the IfStatement is undefined.

14.7: In ECMAScript 2015, if the ( token of a for statement is immediately followed by the token sequence let [ then the let is treated as the start of a LexicalDeclaration. In previous editions such a token sequence would be the start of an Expression.

14.7: In ECMAScript 2015, if the ( token of a for-in statement is immediately followed by the token sequence let [ then the let is treated as the start of a ForDeclaration. In previous editions such a token sequence would be the start of an LeftHandSideExpression.

14.7: Prior to ECMAScript 2015, an initialization expression could appear as part of the VariableDeclaration that precedes the in keyword. In ECMAScript 2015, the ForBinding in that same position does not allow the occurrence of such an initializer. In ECMAScript 2017, such an initializer is permitted only in non-strict code.

14.7: In ECMAScript 2015, the result of evaluating an IterationStatement is never a normal completion whose [[Value]] is empty. If the Statement part of an IterationStatement is not evaluated or if the final evaluation of the Statement part produces a normal completion whose [[Value]] is empty, the result of evaluating the IterationStatement is a normal completion whose [[Value]] is undefined.

14.11.2: In ECMAScript 2015, the result of evaluating a WithStatement is never a normal completion whose [[Value]] is empty. If evaluation of the Statement part of a WithStatement produces a normal completion whose [[Value]] is empty, the result of evaluating the WithStatement is a normal completion whose [[Value]] is undefined.

14.12.4: In ECMAScript 2015, the result of evaluating a SwitchStatement is never a normal completion whose [[Value]] is empty. If evaluation of the CaseBlock part of a SwitchStatement produces a normal completion whose [[Value]] is empty, the result of evaluating the SwitchStatement is a normal completion whose [[Value]] is undefined.

14.15: In ECMAScript 2015, it is an early error for a Catch clause to contain a var declaration for the same Identifier that appears as the Catch clause parameter. In previous editions, such a variable declaration would be instantiated in the enclosing variable environment but the declaration's Initializer value would be assigned to the Catch parameter.

14.15, 19.2.1.3: In ECMAScript 2015, a runtime SyntaxError is thrown if a Catch clause evaluates a non-strict direct eval whose eval code includes a var or FunctionDeclaration declaration that binds the same Identifier that appears as the Catch clause parameter.

14.15.3: In ECMAScript 2015, the result of a TryStatement is never the value empty. If the Block part of a TryStatement evaluates to a normal completion containing empty, the result of the TryStatement is undefined. If the Block part of a TryStatement evaluates to a throw completion and it has a Catch part that evaluates to a normal completion containing empty, the result of the TryStatement is undefined if there is no Finally clause or if its Finally clause evaluates to an empty normal completion.

15.4.5 In ECMAScript 2015, the function objects that are created as the values of the [[Get]] or [[Set]] attribute of accessor properties in an ObjectLiteral are not constructor functions and they do not have a "prototype" own property. In the previous edition, they were constructors and had a "prototype" property.

20.1.2.6: In ECMAScript 2015, if the argument to Object.freeze is not an object it is treated as if it was a non-extensible ordinary object with no own properties. In the previous edition, a non-object argument always causes a TypeError to be thrown.

20.1.2.8: In ECMAScript 2015, if the argument to Object.getOwnPropertyDescriptor is not an object an attempt is made to coerce the argument using ToObject. If the coercion is successful the result is used in place of the original argument value. In the previous edition, a non-object argument always causes a TypeError to be thrown.

20.1.2.10: In ECMAScript 2015, if the argument to Object.getOwnPropertyNames is not an object an attempt is made to coerce the argument using ToObject. If the coercion is successful the result is used in place of the original argument value. In the previous edition, a non-object argument always causes a TypeError to be thrown.

20.1.2.12: In ECMAScript 2015, if the argument to Object.getPrototypeOf is not an object an attempt is made to coerce the argument using ToObject. If the coercion is successful the result is used in place of the original argument value. In the previous edition, a non-object argument always causes a TypeError to be thrown.

20.1.2.16: In ECMAScript 2015, if the argument to Object.isExtensible is not an object it is treated as if it was a non-extensible ordinary object with no own properties. In the previous edition, a non-object argument always causes a TypeError to be thrown.

20.1.2.17: In ECMAScript 2015, if the argument to Object.isFrozen is not an object it is treated as if it was a non-extensible ordinary object with no own properties. In the previous edition, a non-object argument always causes a TypeError to be thrown.

20.1.2.18: In ECMAScript 2015, if the argument to Object.isSealed is not an object it is treated as if it was a non-extensible ordinary object with no own properties. In the previous edition, a non-object argument always causes a TypeError to be thrown.

20.1.2.19: In ECMAScript 2015, if the argument to Object.keys is not an object an attempt is made to coerce the argument using ToObject. If the coercion is successful the result is used in place of the original argument value. In the previous edition, a non-object argument always causes a TypeError to be thrown.

20.1.2.20: In ECMAScript 2015, if the argument to Object.preventExtensions is not an object it is treated as if it was a non-extensible ordinary object with no own properties. In the previous edition, a non-object argument always causes a TypeError to be thrown.

20.1.2.22: In ECMAScript 2015, if the argument to Object.seal is not an object it is treated as if it was a non-extensible ordinary object with no own properties. In the previous edition, a non-object argument always causes a TypeError to be thrown.

20.2.3.2: In ECMAScript 2015, the [[Prototype]] internal slot of a bound function is set to the [[GetPrototypeOf]] value of its target function. In the previous edition, [[Prototype]] was always set to %Function.prototype%.

20.2.4.1: In ECMAScript 2015, the "length" property of function instances is configurable. In previous editions it was non-configurable.

20.5.6.2: In ECMAScript 2015, the [[Prototype]] internal slot of a NativeError constructor is the Error constructor. In previous editions it was the Function prototype object.

21.4.4 In ECMAScript 2015, the Date prototype object is not a Date instance. In previous editions it was a Date instance whose TimeValue was NaN.

22.1.3.12 In ECMAScript 2015, the String.prototype.localeCompare function must treat Strings that are canonically equivalent according to the Unicode Standard as being identical. In previous editions implementations were permitted to ignore canonical equivalence and could instead use a bit-wise comparison.

22.1.3.28 and 22.1.3.30 In ECMAScript 2015, lowercase/upper conversion processing operates on code points. In previous editions such the conversion processing was only applied to individual code units. The only affected code points are those in the Deseret block of Unicode.

22.1.3.32 In ECMAScript 2015, the String.prototype.trim method is defined to recognize white space code points that may exist outside of the Unicode BMP. However, as of Unicode 7 no such code points are defined. In previous editions such code points would not have been recognized as white space.

22.2.4.1 In ECMAScript 2015, If the pattern argument is a RegExp instance and the flags argument is not undefined, a new RegExp instance is created just like pattern except that pattern's flags are replaced by the argument flags. In previous editions a TypeError exception was thrown when pattern was a RegExp instance and flags was not undefined.

22.2.6 In ECMAScript 2015, the RegExp prototype object is not a RegExp instance. In previous editions it was a RegExp instance whose pattern is the empty String.

22.2.6 In ECMAScript 2015, "source", "global", "ignoreCase", and "multiline" are accessor properties defined on the RegExp prototype object. In previous editions they were data properties defined on RegExp instances.

25.4.15: In ECMAScript 2019, Atomics.wake has been renamed to Atomics.notify to prevent confusion with Atomics.wait.

27.1.6.4, 27.6.3.6: In ECMAScript 2019, the number of Jobs enqueued by await was reduced, which could create an observable difference in resolution order between a then() call and an await expression.

Bibliography

  1. IEEE 754-2019: IEEE Standard for Floating-Point Arithmetic. Institute of Electrical and Electronic Engineers, New York (2019) Note

    There are no normative changes between IEEE 754-2008 and IEEE 754-2019 that affect the ECMA-262 specification.

  2. The Unicode Standard, available at <https://unicode.org/versions/latest>
  3. Unicode Technical Note #5: Canonical Equivalence in Applications, available at <https://unicode.org/notes/tn5/>
  4. Unicode Technical Standard #10: Unicode Collation Algorithm, available at <https://unicode.org/reports/tr10/>
  5. Unicode Standard Annex #15, Unicode Normalization Forms, available at <https://unicode.org/reports/tr15/>
  6. Unicode Standard Annex #18: Unicode Regular Expressions, available at <https://unicode.org/reports/tr18/>
  7. Unicode Standard Annex #24: Unicode Script Property, available at <https://unicode.org/reports/tr24/>
  8. Unicode Standard Annex #31, Unicode Identifiers and Pattern Syntax, available at <https://unicode.org/reports/tr31/>
  9. Unicode Standard Annex #44: Unicode Character Database, available at <https://unicode.org/reports/tr44/>
  10. Unicode Technical Standard #51: Unicode Emoji, available at <https://unicode.org/reports/tr51/>
  11. IANA Time Zone Database, available at <https://www.iana.org/time-zones>
  12. ISO 8601:2004(E) Data elements and interchange formats — Information interchange — Representation of dates and times
  13. RFC 1738 “Uniform Resource Locators (URL)”, available at <https://tools.ietf.org/html/rfc1738>
  14. RFC 2396 “Uniform Resource Identifiers (URI): Generic Syntax”, available at <https://tools.ietf.org/html/rfc2396>
  15. RFC 3629 “UTF-8, a transformation format of ISO 10646”, available at <https://tools.ietf.org/html/rfc3629>
  16. RFC 7231 “Hypertext Transfer Protocol (HTTP/1.1): Semantics and Content”, available at <https://tools.ietf.org/html/rfc7231>

Colophon

This specification is authored on GitHub in a plaintext source format called Ecmarkup. Ecmarkup is an HTML and Markdown dialect that provides a framework and toolset for authoring ECMAScript specifications in plaintext and processing the specification into a full-featured HTML rendering that follows the editorial conventions for this document. Ecmarkup builds on and integrates a number of other formats and technologies including Grammarkdown for defining syntax and Ecmarkdown for authoring algorithm steps. PDF renderings of this specification are produced using a print stylesheet which takes advantage of the CSS Paged Media specification and is converted using PrinceXML.

Prior editions of this specification were authored using Word—the Ecmarkup source text that formed the basis of this edition was produced by converting the ECMAScript 2015 Word document to Ecmarkup using an automated conversion tool.

Copyright & Software License

Ecma International

Rue du Rhone 114

CH-1204 Geneva

Tel: +41 22 849 6000

Fax: +41 22 849 6001

Web: https://ecma-international.org/

Software License

All Software contained in this document ("Software") is protected by copyright and is being made available under the "BSD License", included below. This Software may be subject to third party rights (rights from parties other than Ecma International), including patent rights, and no licenses under such third party rights are granted under this license even if the third party concerned is a member of Ecma International. SEE THE ECMA CODE OF CONDUCT IN PATENT MATTERS AVAILABLE AT https://ecma-international.org/memento/codeofconduct.htm FOR INFORMATION REGARDING THE LICENSING OF PATENT CLAIMS THAT ARE REQUIRED TO IMPLEMENT ECMA INTERNATIONAL STANDARDS.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
  3. Neither the name of the authors nor Ecma International may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE ECMA INTERNATIONAL "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL ECMA INTERNATIONAL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.